@capacitor/preferences 4.0.0-beta.0

package/CHANGELOG.md

@@ -0,0 +1,299 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 4.0.0-beta.0 (2022-06-27)
+
+**Note:** Version bump only for package @capacitor/preferences
+
+
+
+
+
+## [1.2.5](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@1.2.4...@capacitor/storage@1.2.5) (2022-03-03)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [1.2.4](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@1.2.3...@capacitor/storage@1.2.4) (2022-01-19)
+
+
+### Bug Fixes
+
+* inline source code in esm map files ([#760](https://github.com/ionic-team/capacitor-plugins/issues/760)) ([a960489](https://github.com/ionic-team/capacitor-plugins/commit/a960489a19db0182b90d187a50deff9dfbe51038))
+
+
+
+
+
+## [1.2.3](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@1.2.2...@capacitor/storage@1.2.3) (2021-11-03)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [1.2.2](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@1.2.1...@capacitor/storage@1.2.2) (2021-10-14)
+
+
+### Bug Fixes
+
+* remove postpublish scripts ([#656](https://github.com/ionic-team/capacitor-plugins/issues/656)) ([ed6ac49](https://github.com/ionic-team/capacitor-plugins/commit/ed6ac499ebf4a47525071ccbfc36c27503e11f60))
+
+
+
+
+
+## [1.2.1](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@1.2.0...@capacitor/storage@1.2.1) (2021-10-13)
+
+
+### Bug Fixes
+
+* correct addListeners links ([#655](https://github.com/ionic-team/capacitor-plugins/issues/655)) ([f9871e7](https://github.com/ionic-team/capacitor-plugins/commit/f9871e7bd53478addb21155e148829f550c0e457))
+
+
+
+
+
+# [1.2.0](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@1.1.0...@capacitor/storage@1.2.0) (2021-09-15)
+
+
+### Features
+
+* **storage:** Add removeOld function ([#585](https://github.com/ionic-team/capacitor-plugins/issues/585)) ([698350e](https://github.com/ionic-team/capacitor-plugins/commit/698350e38a756abc90fb38212b8adfa890c77ce5))
+
+
+
+
+
+# [1.1.0](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@1.0.3...@capacitor/storage@1.1.0) (2021-09-01)
+
+
+### Features
+
+* **storage:** make StorageConfiguration init public ([#532](https://github.com/ionic-team/capacitor-plugins/issues/532)) ([4271b5d](https://github.com/ionic-team/capacitor-plugins/commit/4271b5d18a98201582bd95f41d5b5104c83e5b29))
+
+
+
+
+
+## [1.0.3](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@1.0.2...@capacitor/storage@1.0.3) (2021-07-07)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [1.0.2](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@1.0.1...@capacitor/storage@1.0.2) (2021-06-23)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [1.0.1](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@1.0.0...@capacitor/storage@1.0.1) (2021-06-09)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+# [1.0.0](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.3.10...@capacitor/storage@1.0.0) (2021-05-19)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [0.3.10](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.3.9...@capacitor/storage@0.3.10) (2021-05-11)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [0.3.9](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.3.8...@capacitor/storage@0.3.9) (2021-05-10)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [0.3.8](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.3.7...@capacitor/storage@0.3.8) (2021-05-07)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [0.3.7](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.3.6...@capacitor/storage@0.3.7) (2021-04-29)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [0.3.6](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.3.5...@capacitor/storage@0.3.6) (2021-03-10)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [0.3.5](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.3.4...@capacitor/storage@0.3.5) (2021-03-02)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [0.3.4](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.3.3...@capacitor/storage@0.3.4) (2021-02-27)
+
+
+### Bug Fixes
+
+* **storage:** configure doesn't resolve on Android and iOS ([#266](https://github.com/ionic-team/capacitor-plugins/issues/266)) ([4f51b24](https://github.com/ionic-team/capacitor-plugins/commit/4f51b24d18890ae207090304c153af6c0067fdff))
+
+
+
+
+
+## [0.3.3](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.3.2...@capacitor/storage@0.3.3) (2021-02-10)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [0.3.2](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.3.1...@capacitor/storage@0.3.2) (2021-02-05)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [0.3.1](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.3.0...@capacitor/storage@0.3.1) (2021-01-26)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+# [0.3.0](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.2.0...@capacitor/storage@0.3.0) (2021-01-14)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+# [0.2.0](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.1.4...@capacitor/storage@0.2.0) (2021-01-13)
+
+
+### Bug Fixes
+
+* add es2017 lib to tsconfig ([#180](https://github.com/ionic-team/capacitor-plugins/issues/180)) ([2c3776c](https://github.com/ionic-team/capacitor-plugins/commit/2c3776c38ca025c5ee965dec10ccf1cdb6c02e2f))
+
+
+### Features
+
+* add commonjs output format ([#179](https://github.com/ionic-team/capacitor-plugins/issues/179)) ([8e9e098](https://github.com/ionic-team/capacitor-plugins/commit/8e9e09862064b3f6771d7facbc4008e995d9b463))
+
+
+
+
+
+## [0.1.4](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.1.3...@capacitor/storage@0.1.4) (2021-01-13)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [0.1.3](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.1.2...@capacitor/storage@0.1.3) (2021-01-08)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [0.1.2](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.1.1...@capacitor/storage@0.1.2) (2020-12-27)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [0.1.1](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.1.0...@capacitor/storage@0.1.1) (2020-12-20)
+
+
+### Bug Fixes
+
+* support deprecated types from Capacitor 2 ([#139](https://github.com/ionic-team/capacitor-plugins/issues/139)) ([2d7127a](https://github.com/ionic-team/capacitor-plugins/commit/2d7127a488e26f0287951921a6db47c49d817336))
+
+
+
+
+
+# [0.1.0](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.0.3...@capacitor/storage@0.1.0) (2020-12-02)
+
+**Note:** Version bump only for package @capacitor/storage
+
+
+
+
+
+## [0.0.3](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.0.2...@capacitor/storage@0.0.3) (2020-10-30)
+
+
+### Bug Fixes
+
+* **storage:** Remove warning on getString usage ([#85](https://github.com/ionic-team/capacitor-plugins/issues/85)) ([db9c9c0](https://github.com/ionic-team/capacitor-plugins/commit/db9c9c0d6743488e13c86e3b4efd192b4a28a193))
+
+
+
+
+
+## [0.0.2](https://github.com/ionic-team/capacitor-plugins/compare/@capacitor/storage@0.0.1...@capacitor/storage@0.0.2) (2020-10-12)
+
+
+### Bug Fixes
+
+* better ignore rules for npm distribution ([#32](https://github.com/ionic-team/capacitor-plugins/issues/32)) ([b8d55b9](https://github.com/ionic-team/capacitor-plugins/commit/b8d55b9233e4ad7b8a1cd41110b4e580fc2a059f))
+
+
+
+
+
+## 0.0.1 (2020-09-01)
+
+
+### Bug Fixes
+
+* use correct package in manifest files ([#22](https://github.com/ionic-team/capacitor-plugins/issues/22)) ([ab62987](https://github.com/ionic-team/capacitor-plugins/commit/ab629877e1951f944594f1b23e1bffefcbc783dd))
+
+
+### Features
+
+* Storage plugin ([#15](https://github.com/ionic-team/capacitor-plugins/issues/15)) ([9dfdd85](https://github.com/ionic-team/capacitor-plugins/commit/9dfdd85b39c0df90db416a4bed094d03640fbe34))

package/CapacitorPreferences.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapacitorPreferences'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = 'https://capacitorjs.com'
+  s.author = package['author']
+  s.source = { :git => 'https://github.com/ionic-team/capacitor-plugins.git', :tag => package['name'] + '@' + package['version'] }
+  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}', 'preferences/ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '13.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/LICENSE

@@ -0,0 +1,23 @@
+Copyright 2020-present Ionic
+https://ionic.io
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,259 @@
+# @capacitor/preferences
+
+The Preferences API provides a simple key/value persistent store for lightweight data.
+
+Mobile OSs may periodically clear data set in `window.localStorage`, so this
+API should be used instead. This API will fall back to using `localStorage`
+when running as a Progressive Web App.
+
+This plugin will use
+[`UserDefaults`](https://developer.apple.com/documentation/foundation/userdefaults)
+on iOS and
+[`SharedPreferences`](https://developer.android.com/reference/android/content/SharedPreferences)
+on Android. Stored data is cleared if the app is uninstalled.
+
+**Note**: This API is _not_ meant to be used as a local database. If your app
+stores a lot of data, has high read/write load, or requires complex querying,
+we recommend taking a look at a SQLite-based solution. One such solution is [Ionic Secure Storage](https://ionic.io/docs/secure-storage), a SQLite-based engine with full encryption support. The [Capacitor Community](https://github.com/capacitor-community/) has also built a number of other storage engines.
+
+## Install
+
+```bash
+npm install @capacitor/preferences
+npx cap sync
+```
+
+## Example
+
+```typescript
+import { Preferences } from '@capacitor/preferences';
+
+const setName = async () => {
+  await Preferences.set({
+    key: 'name',
+    value: 'Max',
+  });
+};
+
+const checkName = async () => {
+  const { value } = await Preferences.get({ key: 'name' });
+
+  console.log(`Hello ${value}!`);
+};
+
+const removeName = async () => {
+  await Preferences.remove({ key: 'name' });
+};
+```
+
+## Working with JSON
+
+The Preferences API only supports string values. You can, however, use JSON if you `JSON.stringify` the object before calling `set()`, then `JSON.parse` the value returned from `get()`.
+
+This method can also be used to store non-string values, such as numbers and booleans.
+
+## API
+
+<docgen-index>
+
+* [`configure(...)`](#configure)
+* [`get(...)`](#get)
+* [`set(...)`](#set)
+* [`remove(...)`](#remove)
+* [`clear()`](#clear)
+* [`keys()`](#keys)
+* [`migrate()`](#migrate)
+* [`removeOld()`](#removeold)
+* [Interfaces](#interfaces)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### configure(...)
+
+```typescript
+configure(options: ConfigureOptions) => Promise<void>
+```
+
+Configure the preferences plugin at runtime.
+
+Options that are `undefined` will not be used.
+
+| Param         | Type                                                          |
+| ------------- | ------------------------------------------------------------- |
+| **`options`** | <code><a href="#configureoptions">ConfigureOptions</a></code> |
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### get(...)
+
+```typescript
+get(options: GetOptions) => Promise<GetResult>
+```
+
+Get the value from preferences of a given key.
+
+| Param         | Type                                              |
+| ------------- | ------------------------------------------------- |
+| **`options`** | <code><a href="#getoptions">GetOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#getresult">GetResult</a>&gt;</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### set(...)
+
+```typescript
+set(options: SetOptions) => Promise<void>
+```
+
+Set the value in preferences for a given key.
+
+| Param         | Type                                              |
+| ------------- | ------------------------------------------------- |
+| **`options`** | <code><a href="#setoptions">SetOptions</a></code> |
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### remove(...)
+
+```typescript
+remove(options: RemoveOptions) => Promise<void>
+```
+
+Remove the value from preferences for a given key, if any.
+
+| Param         | Type                                                    |
+| ------------- | ------------------------------------------------------- |
+| **`options`** | <code><a href="#removeoptions">RemoveOptions</a></code> |
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### clear()
+
+```typescript
+clear() => Promise<void>
+```
+
+Clear keys and values from preferences.
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### keys()
+
+```typescript
+keys() => Promise<KeysResult>
+```
+
+Return the list of known keys in preferences.
+
+**Returns:** <code>Promise&lt;<a href="#keysresult">KeysResult</a>&gt;</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### migrate()
+
+```typescript
+migrate() => Promise<MigrateResult>
+```
+
+Migrate data from the Capacitor 2 Storage plugin.
+
+This action is non-destructive. It will not remove old data and will only
+write new data if they key was not already set.
+To remove the old data after being migrated, call removeOld().
+
+**Returns:** <code>Promise&lt;<a href="#migrateresult">MigrateResult</a>&gt;</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### removeOld()
+
+```typescript
+removeOld() => Promise<void>
+```
+
+Removes old data with `_cap_` prefix from the Capacitor 2 Storage plugin.
+
+**Since:** 1.1.0
+
+--------------------
+
+
+### Interfaces
+
+
+#### ConfigureOptions
+
+| Prop        | Type                | Description                                                                                                                                                                                                                                                                                                                                              | Default                       | Since |
+| ----------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | ----- |
+| **`group`** | <code>string</code> | Set the preferences group. Preferences groups are used to organize key/value pairs. Using the value 'NativeStorage' provides backwards-compatibility with [`cordova-plugin-nativestorage`](https://www.npmjs.com/package/cordova-plugin-nativestorage). WARNING: The `clear()` method can delete unintended values when using the 'NativeStorage' group. | <code>CapacitorStorage</code> | 1.0.0 |
+
+
+#### GetResult
+
+| Prop        | Type                        | Description                                                                                                                       | Since |
+| ----------- | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`value`** | <code>string \| null</code> | The value from preferences associated with the given key. If a value was not previously set or was removed, value will be `null`. | 1.0.0 |
+
+
+#### GetOptions
+
+| Prop      | Type                | Description                                       | Since |
+| --------- | ------------------- | ------------------------------------------------- | ----- |
+| **`key`** | <code>string</code> | The key whose value to retrieve from preferences. | 1.0.0 |
+
+
+#### SetOptions
+
+| Prop        | Type                | Description                                                   | Since |
+| ----------- | ------------------- | ------------------------------------------------------------- | ----- |
+| **`key`**   | <code>string</code> | The key to associate with the value being set in preferences. | 1.0.0 |
+| **`value`** | <code>string</code> | The value to set in preferences with the associated key.      | 1.0.0 |
+
+
+#### RemoveOptions
+
+| Prop      | Type                | Description                                     | Since |
+| --------- | ------------------- | ----------------------------------------------- | ----- |
+| **`key`** | <code>string</code> | The key whose value to remove from preferences. | 1.0.0 |
+
+
+#### KeysResult
+
+| Prop       | Type                  | Description                    | Since |
+| ---------- | --------------------- | ------------------------------ | ----- |
+| **`keys`** | <code>string[]</code> | The known keys in preferences. | 1.0.0 |
+
+
+#### MigrateResult
+
+| Prop           | Type                  | Description                                                                                                                           | Since |
+| -------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`migrated`** | <code>string[]</code> | An array of keys that were migrated.                                                                                                  | 1.0.0 |
+| **`existing`** | <code>string[]</code> | An array of keys that were already migrated or otherwise exist in preferences that had a value in the Capacitor 2 Preferences plugin. | 1.0.0 |
+
+</docgen-api>

package/android/build.gradle

@@ -0,0 +1,57 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.4.2'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.3'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.4.0'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:7.2.1'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 32
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 32
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_11
+        targetCompatibility JavaVersion.VERSION_11
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.capacitorjs.plugins.preferences">
+</manifest>