Zeba Academy Secure Storage 🔐

A simple, secure, and developer-friendly Flutter package for encrypted storage, token management, and secure data handling.

✨ Features

✅ Secure encrypted storage ✅ Authentication token management ✅ Refresh token support ✅ JSON data storage ✅ Simple read/write/delete APIs ✅ Clear all stored data ✅ Error handling with custom exceptions ✅ Null-safe and production-ready ✅ Easy Flutter integration

📦 Installation

Add this package to your pubspec.yaml:

dependencies:
  zeba_academy_secure_storage: ^1.0.0

Run:

flutter pub get

🚀 Usage

Import the package:

import 'package:zeba_academy_secure_storage/zeba_academy_secure_storage.dart';

Create storage instance:

final storage = ZebaSecureStorage();

🔑 Token Storage

Save Token

await storage.saveToken(
  "your_access_token",
);

Get Token

final token =
    await storage.getToken();

print(token);

Delete Token

await storage.deleteToken();

🔄 Refresh Token

Save refresh token:

await storage.saveRefreshToken(
  "refresh_token_value",
);

Get refresh token:

final refreshToken =
    await storage.getRefreshToken();

💾 Custom Secure Data

Store Data

await storage.write(
  "username",
  "Sufyan",
);

Read Data

final username =
    await storage.read(
      "username",
    );

Delete Data

await storage.delete(
  "username",
);

📋 JSON Storage

Save JSON:

await storage.saveJson(
  "profile",
  {
    "name": "Sufyan",
    "role": "developer",
  },
);

Read JSON:

final profile =
    await storage.getJson(
      "profile",
    );

print(profile);

🧹 Clear Storage

Remove all stored values:

await storage.clear();

🛠 API Reference

Method	Description
`write()`	Store secure string data
`read()`	Read secure data
`delete()`	Remove specific key
`clear()`	Remove all data
`saveToken()`	Store authentication token
`getToken()`	Retrieve authentication token
`deleteToken()`	Delete token
`saveRefreshToken()`	Store refresh token
`getRefreshToken()`	Retrieve refresh token
`saveJson()`	Store JSON object
`getJson()`	Read JSON object

📱 Example

class AuthService {

final storage = ZebaSecureStorage();


Future<void> login() async {

  await storage.saveToken(
    "abc123",
  );

}


Future<String?> token() {

 return storage.getToken();

}

}

⚙️ Platform Support

Platform	Supported
Android	✅
iOS	✅
Web	⚠️
Windows	✅
macOS	✅
Linux	✅

🤝 Contributing

Contributions are welcome!

Steps:

Fork this repository
Create a feature branch

git checkout -b feature/new-feature

Commit changes

git commit -m "Add new feature"

Push changes

git push origin feature/new-feature

Open a Pull Request

📄 License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0).

You are free to use, modify, and distribute this software under the GPL terms.

See the full license:

LICENSE

👨‍💻 About Me

✨ I’m Sufyan bin Uzayr, an open-source developer passionate about building and sharing meaningful projects.

Learn more about my work:

🌐 sufyanism.com 💼 LinkedIn

🚀 Your all-in-one learning hub!

Explore courses and resources in coding, technology, and development.

Zeba Academy helps developers build practical skills through tutorials, projects, and hands-on learning.

🌐 Website: https://zeba.academy

💻 Courses & resources: https://code.zeba.academy

▶ YouTube: https://www.youtube.com/@zeba.academy

📸 Instagram: https://www.instagram.com/zeba.academy/

Thank you for using Zeba Academy Secure Storage! ❤️