Async Storage v3

.changeset/config.json

@@ -9,9 +9,8 @@
   "updateInternalDependencies": "patch",
   "ignore": [
     "@react-native-async-storage/eslint-config",
-    "async-storage-website",
-    "@react-native-async-storage/api",
-    "@react-native-async-storage/sqlite-storage",
-    "react-native-example-sqlitestorage"
+    "example-react-native",
+    "example-web",
+    "example-common-tests"
   ]
 }

.github/actions/setup-project/action.yml

@@ -3,13 +3,13 @@ description: Install required tools
 inputs:
   java-version:
     description: Desired Java version
-    default: "17"
+    default: "21.0.8"
   node-version:
     required: false
     description: node version to install
     # Use pre-installed Node version in Ubuntu 22.04 runner
     # https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2204-Readme.md
-    default: 20.13.1
+    default: 22.18.0
   windows-fix:
     required: false
     description: https://github.com/actions/setup-node/issues/899#issuecomment-1837381044

.github/requirements.in

@@ -0,0 +1,3 @@
+mike==2.1.3
+mkdocs==1.6.1
+mkdocs-material==9.6.20

.github/requirements.txt

@@ -0,0 +1,98 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile
+#
+babel==2.17.0
+    # via mkdocs-material
+backrefs==5.9
+    # via mkdocs-material
+certifi==2025.8.3
+    # via requests
+charset-normalizer==3.4.3
+    # via requests
+click==8.2.1
+    # via
+    #   mkdocs
+    #   mkdocs-material
+colorama==0.4.6
+    # via mkdocs-material
+ghp-import==2.1.0
+    # via mkdocs
+idna==3.10
+    # via requests
+importlib-metadata==8.7.0
+    # via mike
+importlib-resources==6.5.2
+    # via mike
+jinja2==3.1.6
+    # via
+    #   mike
+    #   mkdocs
+    #   mkdocs-material
+markdown==3.9
+    # via
+    #   mkdocs
+    #   mkdocs-material
+    #   pymdown-extensions
+markupsafe==3.0.2
+    # via
+    #   jinja2
+    #   mkdocs
+mergedeep==1.3.4
+    # via
+    #   mkdocs
+    #   mkdocs-get-deps
+mike==2.1.3
+    # via -r requirements.in
+mkdocs==1.6.1
+    # via
+    #   -r requirements.in
+    #   mike
+    #   mkdocs-material
+mkdocs-get-deps==0.2.0
+    # via mkdocs
+mkdocs-material==9.6.20
+    # via -r requirements.in
+mkdocs-material-extensions==1.3.1
+    # via mkdocs-material
+packaging==25.0
+    # via mkdocs
+paginate==0.5.7
+    # via mkdocs-material
+pathspec==0.12.1
+    # via mkdocs
+platformdirs==4.4.0
+    # via mkdocs-get-deps
+pygments==2.19.2
+    # via mkdocs-material
+pymdown-extensions==10.16.1
+    # via mkdocs-material
+pyparsing==3.2.5
+    # via mike
+python-dateutil==2.9.0.post0
+    # via ghp-import
+pyyaml==6.0.3
+    # via
+    #   mike
+    #   mkdocs
+    #   mkdocs-get-deps
+    #   pymdown-extensions
+    #   pyyaml-env-tag
+pyyaml-env-tag==1.1
+    # via
+    #   mike
+    #   mkdocs
+requests==2.32.5
+    # via mkdocs-material
+six==1.17.0
+    # via python-dateutil
+urllib3==2.5.0
+    # via requests
+verspec==0.1.0
+    # via mike
+watchdog==6.0.0
+    # via mkdocs
+zipp==3.23.0
+    # via importlib-metadata

.github/scripts/prepare-mkdocs.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# The website is built using MkDocs with the Material theme.
+# https://squidfunk.github.io/mkdocs-material/
+# It requires Python to run.
+# Install the packages with the following command:
+# pip install --no-deps -r requirements.txt
+
+
+cp packages/async-storage/CHANGELOG.md docs/changelog.md

.github/workflows/default-storage.yml

@@ -15,7 +15,7 @@ jobs:
           token: ${{ secrets.GH_RELEASE_TOKEN }}
           filters: |
             storage:
-              - 'packages/default-storage/**'
+              - 'packages/async-storage/**'
 
   android:
     name: Android
@@ -35,11 +35,11 @@ jobs:
         with:
           gradle-version: wrapper
           arguments: react-native-async-storage_async-storage:test
-          build-root-directory: packages/default-storage/example/android
+          build-root-directory: packages/async-storage/example/android
       - name: Build e2e binary
         run: |
           yarn build:e2e:android
-        working-directory: packages/default-storage/example
+        working-directory: packages/async-storage/example
 
   ios:
     name: iOS
@@ -54,7 +54,7 @@ jobs:
       - name: Cache /.ccache
         uses: actions/cache@v3
         with:
-          path: packages/default-storage/.ccache
+          path: packages/async-storage/.ccache
           key: ccache-ios-${{ hashFiles('yarn.lock') }}
           restore-keys: ccache-ios-
       - name: Install JS dependencies
@@ -63,15 +63,15 @@ jobs:
       - name: Bundle JS
         run: |
           yarn bundle:ios
-        working-directory: packages/default-storage/example
+        working-directory: packages/async-storage/example
       - name: Install Pods
         run: |
           RCT_NEW_ARCH_ENABLED=1 pod install
-        working-directory: packages/default-storage/example/ios
+        working-directory: packages/async-storage/example/ios
       - name: Build e2e binary
         run: |
           yarn build:e2e:ios
-        working-directory: packages/default-storage/example
+        working-directory: packages/async-storage/example
 
   macos:
     name: macOS
@@ -86,7 +86,7 @@ jobs:
       - name: Cache /.ccache
         uses: actions/cache@v3
         with:
-          path: packages/default-storage/.ccache
+          path: packages/async-storage/.ccache
           key: ccache-macos-${{ hashFiles('yarn.lock') }}
           restore-keys: ccache-macos-
       - name: Install JS dependencies
@@ -95,20 +95,20 @@ jobs:
       - name: Bundle JS
         run: |
           yarn bundle:macos
-        working-directory: packages/default-storage/example
+        working-directory: packages/async-storage/example
       - name: Install Pods
         run: |
           RCT_NEW_ARCH_ENABLED=1 pod install
-        working-directory: packages/default-storage/example/macos
+        working-directory: packages/async-storage/example/macos
       - name: Build
         run: |
           yarn build:e2e:macos
-        working-directory: packages/default-storage/example
+        working-directory: packages/async-storage/example
       - name: Test
         if: false
         run: |
           yarn test:e2e:macos
-        working-directory: packages/default-storage/example
+        working-directory: packages/async-storage/example
 
   windows:
     name: Windows
@@ -132,8 +132,8 @@ jobs:
       - name: Install Windows test app
         run: |
           yarn install-windows-test-app -p windows
-        working-directory: packages/default-storage/example
+        working-directory: packages/async-storage/example
       - name: Build
         run: |
           yarn react-native run-windows --release --arch x64 --logging --no-packager --no-launch --no-deploy --msbuildprops "BundleEntryFile=index.ts,UseBundle=false" --no-telemetry
-        working-directory: packages/default-storage/example
+        working-directory: packages/async-storage/example

.github/workflows/deploy-docs.yml

@@ -0,0 +1,44 @@
+name: Deploy docs
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'packages/async-storage/CHANGELOG.md'
+  workflow_dispatch:
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          token: ${{ secrets.GH_BOT_TOKEN }}
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.11
+      - name: Read docs version
+        id: version
+        run: |
+          VERSION_DOCS=$(node -p "require('./package.json').versionDocs || ''")
+          echo "versionDocs=$VERSION_DOCS" >> $GITHUB_OUTPUT
+      - name: Prepare MkDocs
+        run: |
+          pip install --no-deps -r .github/requirements.txt
+          .github/scripts/prepare-mkdocs.sh
+      # required for mike
+      - name: Setup git user
+        run: ./setup-ci-git-user.sh
+        working-directory: .github/scripts
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_RELEASE_TOKEN }}
+          GITHUB_NAME: ${{ vars.GH_BOT_NAME }}
+          GITHUB_EMAIL: ${{ vars.GH_BOT_EMAIL }}
+          GIT_SET_GLOBAL_USER: true
+      # required for mike
+      - name: Setup gh-pages remote
+        run: |
+          git remote add docs https://github.com/react-native-async-storage/react-native-async-storage.github.io.git
+      - name: Deploy Docs with mike
+        run: mike deploy -u -r docs --push ${{ steps.version.outputs.versionDocs }} latest

.gitignore

@@ -31,8 +31,25 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log
 yarn-error.log*
+.kotlin
+**/build/
+xcuserdata
+!src/**/build/
+captures
+.externalNativeBuild
+.cxx
+*.xcodeproj/*
+!*.xcodeproj/project.pbxproj
+!*.xcodeproj/xcshareddata/
+!*.xcodeproj/project.xcworkspace/
+!*.xcworkspace/contents.xcworkspacedata
+**/xcshareddata/WorkspaceSettings.xcsettings
+
 
 #workspaces
 .turbo
 /packages/*/lib
 build/
+
+# mkdocs
+site/