tvf_flutter_graphql 1.1.1

GraphQL Query and Mutation Examples Reference for Flutter/Dart. This is a reference package only - DO NOT install. Browse the source code to copy GraphQL query and mutation strings for use in your app.

TVF Flutter GraphQL Examples Reference

⚠️ This is a REFERENCE package only - DO NOT install it in your app.

This package contains GraphQL query and mutation examples. Browse the source code to copy the query/mutation strings and use them directly in your app.

📖 How to Use

Option 1: Browse Source Code (Recommended)

1. Navigate to the package source code:

   • Go to packages/flutter-schema/lib/src/queries/ for queries
   • Go to packages/flutter-schema/lib/src/mutations/ for mutations

2. Copy the query/mutation string:

   // Example from lib/src/queries/user_queries.dart
   const getUserQuery = '''
     query GetUser($id: ID!) {
       getUser(id: $id) {
         id
         userId
         username
         email
         fullName
       }
     }
   ''';
   

3. Use directly in your app:

   // In your app code (e.g., Counter.tsx)
   const getUserCountQuery = `
     query GetUserCount($active: Boolean, $newUsers: Boolean) {
       getUserCount(active: $active, newUsers: $newUsers) {
         count
       }
     }
   `;
      
   const result = await apiClient.graphql({
     query: getUserCountQuery,
     variables: { active: true, newUsers: false },
   });
   

Option 2: View Examples in Code

Look at example usage in:

• next/app/components/Counter.tsx:
  • Line 101-104: GetCount query example
  • Line 170-174: GetUserCount query example
• next/app/components/UserList.tsx:
  • Line 42-52: DeactivateUser mutation example
  • Line 73-83: ReactivateUser mutation example
  • Line 104-114: RemoveUser mutation example
  • Line 186-189: GetCount query example
  • Line 203-207: GetUserCount query example
• next/app/components/PushCommandTest.tsx (line 46-55): PushCommand mutation example
• next/app/components/DeviceControl.tsx (line 42-51): ControlDevice mutation example

📚 Available GraphQL Examples

Queries

User Queries

• Get User: lib/src/queries/user_queries.dart → UserQueries.getUser
• List Users: lib/src/queries/user_queries.dart → UserQueries.listUsers
• Get User Count: lib/src/queries/user_queries.dart → UserQueries.getUserCount (see Counter.tsx line 170-174)
• Get Count (any model): lib/src/queries/user_queries.dart → UserQueries.getCount (see Counter.tsx line 101-104)

Device Queries

• Get Device: lib/src/queries/device_queries.dart → DeviceQueries.getDevice
• List Devices: lib/src/queries/device_queries.dart → DeviceQueries.listDevices

Device Token Queries

• Get Device Token: lib/src/queries/device_token_queries.dart → DeviceTokenQueries.getDeviceToken
• List Device Tokens: lib/src/queries/device_token_queries.dart → DeviceTokenQueries.listDeviceTokens
• Tokens By User: lib/src/queries/device_token_queries.dart → DeviceTokenQueries.tokensByUser

Notification Queries

• Get Notification: lib/src/queries/notification_queries.dart → NotificationQueries.getNotification
• List Notifications: lib/src/queries/notification_queries.dart → NotificationQueries.listNotifications
• Notifications By User: lib/src/queries/notification_queries.dart → NotificationQueries.notificationsByUser

Mutations

User Mutations

• Update User: lib/src/mutations/user_mutations.dart → UserMutations.updateUser
• Deactivate User: lib/src/mutations/user_mutations.dart → UserMutations.deactivateUser
• Reactivate User: lib/src/mutations/user_mutations.dart → UserMutations.reactivateUser
• Remove User: lib/src/mutations/user_mutations.dart → UserMutations.removeUser

Device Mutations

• Create Device: lib/src/mutations/device_mutations.dart → DeviceMutations.createDevice
• Update Device: lib/src/mutations/device_mutations.dart → DeviceMutations.updateDevice
• Push Command: lib/src/mutations/device_mutations.dart → DeviceMutations.pushCommand (see PushCommandTest.tsx line 46-55)
• Control Device: lib/src/mutations/device_mutations.dart → DeviceMutations.controlDevice (see DeviceControl.tsx line 42-51)

Device Token Mutations

• Create Device Token: lib/src/mutations/device_token_mutations.dart → DeviceTokenMutations.createDeviceToken
• Update Device Token: lib/src/mutations/device_token_mutations.dart → DeviceTokenMutations.updateDeviceToken
• Delete Device Token: lib/src/mutations/device_token_mutations.dart → DeviceTokenMutations.deleteDeviceToken

Notification Mutations

• Update Notification: lib/src/mutations/notification_mutations.dart → NotificationMutations.updateNotification

💡 Examples

Example 1: GetCount Query

Source: lib/src/queries/user_queries.dart → UserQueries.getCount
Reference: next/app/components/Counter.tsx (line 101-104)

query GetCount($modelName: String!) {
  getCount(modelName: $modelName)
}

Usage:

const getCountQuery = `
  query GetCount($modelName: String!) {
    getCount(modelName: $modelName)
  }
`;

const result = await apiClient.graphql({
  query: getCountQuery,
  variables: { modelName: 'User' },
});

Example 2: GetUserCount Query

Source: lib/src/queries/user_queries.dart → UserQueries.getUserCount
Reference: next/app/components/Counter.tsx (line 170-174)

query GetUserCount($active: Boolean, $newUsers: Boolean) {
  getUserCount(active: $active, newUsers: $newUsers) {
    count
  }
}

Usage:

const getUserCountQuery = `
  query GetUserCount($active: Boolean, $newUsers: Boolean) {
    getUserCount(active: $active, newUsers: $newUsers) {
      count
    }
  }
`;

const result = await apiClient.graphql({
  query: getUserCountQuery,
  variables: { active: true, newUsers: false },
});

Example 3: DeactivateUser Mutation

Source: lib/src/mutations/user_mutations.dart → UserMutations.deactivateUser
Reference: next/app/components/UserList.tsx (line 42-52)

mutation DeactivateUser($userId: String!, $useEmail: Boolean) {
  deactivateUser(userId: $userId, useEmail: $useEmail) {
    success
    username
    cognitoDisabled
    dynamoDbUpdated
    error
  }
}

Usage:

const mutation = `
  mutation DeactivateUser($userId: String!, $useEmail: Boolean) {
    deactivateUser(userId: $userId, useEmail: $useEmail) {
      success
      username
      cognitoDisabled
      dynamoDbUpdated
      error
    }
  }
`;

const result = await apiClient.graphql({
  query: mutation,
  variables: { userId: 'user-id', useEmail: false },
});

Example 4: PushCommand Mutation

Source: lib/src/mutations/device_mutations.dart → DeviceMutations.pushCommand
Reference: next/app/components/PushCommandTest.tsx (line 46-55)

mutation PushCommand($topic: String!, $payload: AWSJSON!) {
  pushCommand(topic: $topic, payload: $payload) {
    success
    topic
    messageId
    error
  }
}

Usage:

const mutation = `
  mutation PushCommand($topic: String!, $payload: AWSJSON!) {
    pushCommand(topic: $topic, payload: $payload) {
      success
      topic
      messageId
      error
    }
  }
`;

const result = await apiClient.graphql({
  query: mutation,
  variables: {
    topic: 'iot/device-id/down/command',
    payload: JSON.stringify({ command: 'setTemperature', temperature: 75 }),
  },
});

Example 5: ControlDevice Mutation

Source: lib/src/mutations/device_mutations.dart → DeviceMutations.controlDevice
Reference: next/app/components/DeviceControl.tsx (line 42-51)

mutation ControlDevice($deviceId: String!, $command: String!, $action: String!, $heater: String, $params: AWSJSON) {
  controlDevice(deviceId: $deviceId, command: $command, action: $action, heater: $heater, params: $params) {
    success
    requestId
    topic
    error
  }
}

Usage:

const mutation = `
  mutation ControlDevice($deviceId: String!, $command: String!, $action: String!, $heater: String, $params: AWSJSON) {
    controlDevice(deviceId: $deviceId, command: $command, action: $action, heater: $heater, params: $params) {
      success
      requestId
      topic
      error
    }
  }
`;

const result = await apiClient.graphql({
  query: mutation,
  variables: {
    deviceId: 'device-123',
    command: 'setTemperature',
    action: 'set',
    heater: 'f1',
    params: null,
  },
});

📁 Package Structure

lib/
├── src/
│   ├── queries/          # GraphQL query examples
│   │   ├── user_queries.dart
│   │   ├── device_queries.dart
│   │   ├── device_token_queries.dart
│   │   └── notification_queries.dart
│   └── mutations/        # GraphQL mutation examples
│       ├── user_mutations.dart
│       ├── device_mutations.dart
│       ├── device_token_mutations.dart
│       └── notification_mutations.dart
└── tvf_flutter_graphql.dart  # Main export (for reference)

⚠️ Important Notes

1. DO NOT install this package in your app
2. Browse the source code to find query/mutation examples
3. Copy the query/mutation strings directly into your app code
4. No dependencies required - just copy the strings
5. This package is for reference/documentation purposes only

🔍 Finding Examples

• Queries: Check lib/src/queries/*.dart files
• Mutations: Check lib/src/mutations/*.dart files
• Real usage examples: Check next/app/components/Counter.tsx and UserList.tsx

📄 License

See LICENSE file for details.