kombu_flutter_schema 1.0.0

KOMBU IoT System - GraphQL Schema for Flutter/Dart

kombu_flutter_schema

KOMBU IoT System - GraphQL Schema for Flutter/Dart

Installation

Add this to your package's pubspec.yaml file:

dependencies:
  kombu_flutter_schema: ^1.0.0

Then run:

flutter pub get

Usage

Import

import 'package:kombu_flutter_schema/kombu_flutter_schema.dart';

Use Models

// Parse JSON to User model
final userJson = {...};
final user = User.fromJson(userJson);

// Convert User to JSON
final json = user.toJson();

Use GraphQL Queries

import 'package:graphql_flutter/graphql_flutter.dart';

// Use with GraphQL client
final client = GraphQLClient(...);

final query = gql(UserQueries.getUser);
final result = await client.query(
  QueryOptions(
    document: query,
    variables: {'id': 'user-id'},
  ),
);

Use GraphQL Mutations

final mutation = gql(UserMutations.createUser);
final result = await client.mutate(
  MutationOptions(
    document: mutation,
    variables: {
      'input': {
        'userId': 'user-id',
        'username': 'username',
        'email': '[e-mail]',
      },
    },
  ),
);

Models

• User - User model
• Device - Device model
• DeviceTelemetry - Device telemetry model
• DeviceConfiguration - Device configuration model
• Timer - Timer model
• Notification - Notification model
• Firmware - Firmware model
• Alert - Alert model

GraphQL Operations

Queries

• UserQueries.getUser - Get user by ID
• UserQueries.listUsers - List users
• DeviceQueries.getDevice - Get device by ID
• DeviceQueries.listDevices - List devices

Mutations

• UserMutations.createUser - Create user
• UserMutations.updateUser - Update user
• UserMutations.deleteUser - Delete user
• DeviceMutations.createDevice - Create device
• DeviceMutations.updateDevice - Update device
• DeviceMutations.deleteDevice - Delete device

Subscriptions

• UserSubscriptions.onCreateUser - Subscribe to user creation
• UserSubscriptions.onUpdateUser - Subscribe to user updates
• DeviceSubscriptions.onCreateDevice - Subscribe to device creation
• DeviceSubscriptions.onUpdateDevice - Subscribe to device updates

License

MIT