basecraft #

A reusable project setup package for Flutter applications — includes core utilities, networking layer, base configurations, and helper functions to streamline app development.

✨ Features #

• 📦 Easy integration into any Flutter app
• 🌐 Pre-configured network layer (Dio, interceptors)
• 📁 Path and file helpers (path_provider)
• 🧱 Modular architecture ready for scaling
• 🔧 Utility functions for common tasks

🚀 Getting Started #

Add this package to your pubspec.yaml:

dependencies:
  basecraft: ^2.2.0

Then run:

flutter pub get

ApiClient (Dart) #

A powerful, customizable, and easy-to-use API client built for Dart and Flutter. This singleton class provides support for common HTTP methods (GET, POST, PUT, PATCH, DELETE), file downloading, error handling, and connectivity checks.

✨ Features #

• ✅ Singleton design for easy global access
• 🔗 Base URL and custom headers configuration
• ⏱ Configurable timeouts for requests
• 🪵 Built-in logging interceptor for request/response logs
• 🌐 Internet connectivity checker
• 📥 File download support
• 🧠 Automatic error handling with meaningful messages

🚀 Getting Started #

Initialization

ApiClient.instance.init(
baseUrl: "https://api.example.com",
connectTimeout: Duration(seconds: 10),
receiveTimeout: Duration(seconds: 10),
);

🧪 Usage Examples #

GET Request

final response = await ApiClient.instance.get("/users", query: {"page": 1});

POST Request

final response = await ApiClient.instance.post("/login", {
"email": "[email protected]",
"password": "123456",
});

PUT Request

final response = await ApiClient.instance.put("/users/1", {
"name": "Updated Name",
});

PATCH Request

final response = await ApiClient.instance.patch("/users/1", {
"email": "[email protected]",
});

DELETE Request

final response = await ApiClient.instance.delete("/users/1");

DOWNLOAD Request

final file = await ApiClient.instance.download("https://example.com/file.pdf");

INTERNET CONNECTIVITY CHECK

bool isOnline = await ApiClient.instance.isConnected();

SqfLiteService (Dart/Flutter) #

A singleton service for managing SQLite database operations using the sqflite package in Flutter. This service provides a structured and reusable interface for common CRUD operations with customizable database configuration through an abstract DbHelper.

✨ Features #

• 🔄 Singleton pattern to ensure a single instance of the database

• 🧱 Abstract DbHelper for customizable DB/table configuration

• 📁 Support for basic CRUD operations:

  • get()
  • add()
  • update()
  • delete()

• ⚠️ Error handling with descriptive messages

• 🧩 Hooks for upgrade/downgrade callbacks

🧪 Example Usage #

1. Create a DbHelper Implementation

class MyDbHelper extends DbHelper {
  @override
  String get databaseName => 'my_database.db';

  @override
  int get version => 1;

  @override
  String get tableName => 'users';

  @override
  String get createTable => '''
    CREATE TABLE users (
      id INTEGER PRIMARY KEY AUTOINCREMENT,
      name TEXT,
      email TEXT
    )
  ''';

  @override
  Function(Database, int, int)? get onUpgrade => (db, oldVersion, newVersion) {
    // Handle upgrade logic
  };

  @override
  Function(Database, int, int)? get onDowngrade => (db, oldVersion, newVersion) {
    // Handle downgrade logic
  };
}

2. Initialize the Database

final SqfLiteService sqfLiteService = SqfLiteService(helper: Helper());
await sqfLiteService.init();

3. Perform CRUD Operations

CREATE

await sqfLiteService.add({
'name': 'John Doe',
'email': '[email protected]',
});

READ

final data = await sqfLiteService.get(orderBy: 'name ASC');

UPDATE

await sqfLiteService.update(
{'email': '[email protected]'},
'id = 1',
);

DELETE

await sqfLiteService.delete(where: 'id = 1');

AppStorage (Dart/Flutter) #

A lightweight singleton wrapper around get_storage for simple key-value storage in Flutter. Ideal for saving user preferences, flags, tokens, and other small pieces of persistent data.

✨ Features #

• ✅ Singleton pattern for global access

• 🧠 In-memory + persistent key-value storage

• 📂 Customizable storage container name

• 🗝 Simple read/write/delete interface

• 🧹 Supports clearing entire storage

🚀 Usage #

1. Initialize Storage

⚠️ You must initialize the storage before using it.

await AppStorage.instance.init(); // Optionally: init(containerName: 'MyBox')

2. Set a Value

AppStorage.instance.setValueFor('isLoggedIn', true);

3. Get a Value

var isLoggedIn = AppStorage.instance.valueFor('isLoggedIn');

4. Remove a Value

AppStorage.instance.removeKey('isLoggedIn');

5. Clear All Stored Data

AppStorage.instance.clear();

🧪 Example

void main() async {
  await AppStorage.instance.init();

  AppStorage.instance.setValueFor('theme', 'dark');
  var theme = AppStorage.instance.valueFor('theme');
  print('Current theme: $theme'); // Output: dark

  AppStorage.instance.removeKey('theme');
  AppStorage.instance.clear(); // Removes everything
}

CacheStorage (Dart/Flutter) #

A static utility class for basic local file operations in Dart/Flutter. It provides an easy-to-use API for saving, reading, and deleting both text and binary files in a specified directory.

📦 Features #

• 📄 Save and read text files (.txt)
• 🧱 Save and read binary files (Uint8List)
• 🧹 Delete files from disk
• 📁 Automatically creates target directories if they don’t exist
• 🪶 Lightweight and dependency-free (uses dart:io)

🚀 Getting Started #

1. Save a Text File

await CacheStorage.saveTextFile('/path/to/folder', 'example', 'Hello, World!');

2. Read a Text File

String? contents = await CacheStorage.readTextFile('/path/to/folder', 'example');
print(contents); // "Hello, World!"

3. Save a Binary File

Uint8List bytes = await getSomeBinaryData();
await CacheStorage.saveFile('/path/to/folder', 'image.png', bytes);

4. Read a Binary File

Uint8List? bytes = await CacheStorage.readFile('/path/to/folder', 'image.png');
if (bytes != null) {
// Do something with the binary data
}

5. Delete a File

await CacheStorage.delete('/path/to/folder', 'example.txt');

📁 File Location Tips #

You can use the path_provider package to get platform-specific directories:

import 'package:path_provider/path_provider.dart';

final directory = await getApplicationDocumentsDirectory();
await CacheStorage.saveTextFile(directory.path, 'myfile', 'Hello');

Glass Widget #

A simple Flutter widget that adds a glassmorphism effect.

🔧 Constructor #

Glass({
double blurX = 0,
double blurY = 0,
BorderRadiusGeometry? borderRadius,
Widget? child,
})

📚 PaginationController & PagingListView #

A lightweight, flexible solution for paginated list views in Flutter with pull-to-refresh and infinite scroll support.

📘 How to Use PaginationController & PagingListView #

1. Create a Controller

final controller = PaginationController<MyItem>(
  limit: 20,
  fetchPage: (page, size) => myApi.getItems(page, size),
);

2. Use with PagingListView

PagingListView<MyItem>(
controller: controller,
itemBuilder: (context, item, index) {
return ListTile(title: Text(item.title));
},
separatorWidget: Divider(),
emptyListWidget: Text('No items found'),
loadingWidget: Center(child: CircularProgressIndicator()),
);

3. Refresh Manually (Optional)

ElevatedButton(
onPressed: () {
controller.refresh();
},
child: Text("Reload"),
)

✍️ SignaturePage #

The SignaturePage widget provides a canvas for users to draw their signature using touch input. It allows users to clear the canvas or save the signature as an image file.

🚀 Usage #

Navigator.of(context).push(MaterialPageRoute(builder: (context) => SignaturePage())).then((value) {
  if (value != null) {
    // Here, you get the path of saved signature.
  }
});

🎞️ Animation Widgets #

The animation widgets like FadeIn, FadeOut, Flip, Rotate, Slide, ZoomIn, ZoomOut, and Pulse from the basecraft package allow you to easily add repeatable animations to any widget.

These animations can be customized and reused across your UI to create smooth, eye-catching effects.

🚀 Usage #

Wrap any widget with an animation widget:

FadeIn(
repeat: true,
child: YourWidget(),
);

Rotate(
repeat: true,
child: Container(color: Colors.green),
);

Flip(
axis: FlipAxis.Y,
repeat: true,
child: Text("Flip Me"),
);

📡 Websocket Utility #

It manages WebSocket connections with simplified APIs for initializing, listening, emitting, and closing connections.

✅ Features #

• Singleton access: Websocket.instance
• Auto-connect to WebSocket URL with ping and SSL options
• Customizable connection lifecycle callbacks
• Message handling, event listening, and emitting
• Graceful close support

🔧 Usage #

Initialized

Websocket.instance.init(
url: 'ws://yourserver.com',
onOpen: () => print('✅ WebSocket connected!'),
onClose: (close) => print('❌ WebSocket closed: $close'),
onError: (error) => print('⚠️ WebSocket error: $error'),
);

Perform operation on message receive

Websocket.instance.onMessage((msg) {
print("📩 Message received: $msg");
});

Listen to Events

Websocket.instance.listenTo("chat", (data) {
print("💬 Chat event: $data");
});

Sent Message to Specific Event

Websocket.instance.sentTo(event: "join", data: {"room": "flutter"});

Send Message

Websocket.instance.send("Simple string message");

Close Connection

Websocket.instance.close(reason: "App exit");

🌐 CheckInternet Utility #

A lightweight Dart singleton class for monitoring internet connectivity status in real-time.
It checks for connectivity by resolving google.com periodically and updates the status accordingly.

📦 Features #

• Singleton access via CheckInternet.instance
• Periodic internet status checks (defaults to every 5 seconds)
• Uses native Dart dart:io (no extra dependencies)
• Enum-based connection status: online, offline, unknown
• Ability to stop checks manually with .stop()

🚀 Usage #

Start monitoring

CheckInternet.instance.init(duration: Duration(seconds: 10));

Access current connection status

var status = CheckInternet.instance.status;

Stop monitoring when done

CheckInternet.instance.stop();

🔐 PermissionHandler Utility #

A Flutter singleton utility for managing and checking runtime permissions across multiple platforms.
This class simplifies permission handling by abstracting platform-specific logic behind a clean Dart interface.

📦 Features #

• Singleton access via PermissionHandler.instance
• Supports checking and requesting:
  • Camera
  • Microphone
  • Bluetooth
  • Storage
  • Contacts
  • Location
  • Notification
  • Biometric
  • Calendar
  • Motion Sensors
• Provides individual permission getters for easier UI/state logic
• Uses a unified platform interface for calling native platform code

🚀 Usage #

✅ Initialize with Specific Permissions

await PermissionHandler.instance.init([
Permission.camera,
Permission.microphone,
Permission.location,
]);

🔍 Check Current Permission Status

bool isCameraGranted = PermissionHandler.instance.isCameraPermissionGranted;
bool isLocationGranted = PermissionHandler.instance.isLocationPermissionGranted;

📤 Request a Specific Permission

bool granted = await PermissionHandler.instance.requestPermission(Permission.camera);

⚙️ Open App Setting

PermissionHandler.instance.openSettings();

🔄 Shimmer Widget #

Easily add shimmer loading placeholders with basecraft.

✅ Basic Usage #

Shimmer(
isLoading: true,
child: YourActualWidget(),
)

🎨 With Custom Shimmer Layout #

Shimmer(
  isLoading: true,
  shimmerWidget: YourShimmerPlaceholder(),
  child: YourActualWidget(),
)

⚙️ Parameters #

⏳ Debounce Utility #

A small Dart/Flutter utility to delay function execution until the user stops triggering an action for a given time.

📦 Usage #

Create a debouncer

final debounce = Debounce(
  delay: Duration(milliseconds: 500),
);

🔍 Call it #

debounce(() {
  print('Action executed after delay');
});

If called again before the delay ends, the previous call is cancelled.

❌ Cancel (optional) #

debounce.cancel();

Call this in dispose() if needed.

🚦 Throttle Utility #

A lightweight Dart/Flutter utility to limit how often a function can run. Throttle ensures a function is executed at most once within a given time interval.

Usage #

Create a throttle instance:

final throttle = Throttle(
  delay: Duration(seconds: 1),
);

Call it: #

throttle(() {
  print('Action executed');
});

Calls made before the delay ends are ignored ⛔

🏭 Device Info & Battery Utilities #

Simple utilities to fetch device information and battery status on Android and iOS.

📱 Get Device Info #

Returns platform-specific device info.

final info = await DeviceInfo.getDeviceInfo();

You can check the platform type:

if (info is AndroidDeviceInfo) {
  print(info.model);
}
if (info is IosDeviceInfo) {
  print(info.systemVersion);
}

🔋 Get Battery Level #

Returns battery percentage (0–100).

final level = await DeviceBattery.getBatteryLevel();
print("Battery: $level%");

🔌 Get Battery Status #

Returns the current battery status.

final status = await DeviceBattery.getBatteryStatus();
print(status);

🟰 Equalizer Class #

Equalizer is a Dart/Flutter base class for value-based equality. It compares objects by their properties instead of instance identity.

☑️ Usage #

1. Extend Equalizer.
2. Override properties to list fields used for comparison.
3. Optionally override stringify to include properties in toString().

class Person extends Equalizer {
  final String name;
  final int age;

  const Person(this.name, this.age);

  @override
  List<Object?> get properties => [name, age];
}

void main() {
  const p1 = Person('Alice', 25);
  const p2 = Person('Alice', 25);

  print(p1 == p2); // true
  print(p1);       // Person(name: Alice, age: 25)
}

📃 License #

This project is licensed under the MIT License.

💬 Author #

Made️ by ⚡️ Rugved Apraj