synrg library

A Very Good Project created by Very Good CLI.

Classes

FileUtils
Utility class for file helpers
FK<T extends SynrgClass>
A Foreign Key relation
LFK<T extends SynrgClass>
A List of Foreign Key relation
Location
A class representing a location with address, city, state, country, and postal code.
MyCustomForm
MyCustomFormState
MyStatelessForm
PaginatedResult<T>
Holds the data list and the snapshot of the last document for pagination.
Project
QueryFilter
Represents a filter for querying data in a database.
QueryList
Creates Paginated list of items from a query with pagination
Synrg
A Very Good Project created by Very Good CLI.
SynrgAnalytics
A Firebase Analytics wrapper
SynrgAudio
Audio extension
SynrgAuth
Handles user authentication state
SynrgBlocProvider<B extends BlocBase<Object?>>
Synrg Bloc Provider, is a wrapper to the Bloc Consumer which facilitates the user feedback by adding a listener for any alerts emitted from the BLoC
SynrgButton
SynrgButtonTheme
SynrgClass
SynrgColors
SynrgCrashlytics
A Firebase Crashlytics wrapper
SynrgDocument
Document extension
SynrgFile
Base class
SynrgFormField
SynrgFunction<T extends SynrgClass>
Firebase functions wrapper, it calls the function with the given name and parses the response to the given class.
SynrgImage
Image extension
SynrgIndexer<T extends SynrgClass>
Firestore Wrapper, get and set given a "collectionName"
SynrgModal
SynrgNavigation
SynrgPerformance
A Firebase Performance Monitoring wrapper
SynrgProfile
SynrgRealtimeDatabase
A Firebase Realtime Database wrapper
SynrgRemoteConfig
A Firebase Remote Config wrapper
SynrgResult<T>
SynrgSize
SynrgState
This state is a facilitator to use Synrg Bloc Provide It adds an alert to all states enabling seamless user feedback
SynrgStorage
A Firebase Cloud Storage wrapper
SynrgText
SynrgTextTheme
SynrgTheme
SynrgVideo
Video extension
VisualElements

Enums

AlertLevel
Alert Type
RequestStatus
Used to represent the status of a request in the ui
SynrgFunctionStatus
Possible function status
SynrgModalType

Constants

val → const double

Functions

dummy2() → void
dummy3() Future<void>
dummy4() Future<void>
dummy5() Future<void>
dummy6() Future<void>
dummy7() Future<void>
parseDate(dynamic value) DateTime
Parse a date from a dynamic value.
setUserId(String? userId) Future<void>
This function sets the id for all all the app monitoring services
validateAge(String? value) String?
Validates an Age. Returns null if valid, or an error message string if invalid.
validateAircraftTailNumber(String? value) String?
Validates an Aircraft Tail Number. Returns null if valid, or an error message string if invalid.
validateAllergies(String? value) String?
Validates Allergies information. Since allergies can vary widely, this function mainly checks for non-empty input. Returns null if valid, or an error message string if invalid.
validateAPIKey(String? value) String?
Validates an API Key. Returns null if valid, or an error message string if invalid.
validateArgentinianDNI(String? value) String?
Validates an Argentinian National Identification Document (Documento Nacional de Identidad). Returns null if valid, or an error message string if invalid.
validateBankAccountNumber(String? value) String?
Validates a Bank Account Number. Returns null if valid, or an error message string if invalid.
validateBarcode(String? value) String?
Validates a Barcode. Returns null if valid, or an error message string if invalid.
validateBICSWIFTCode(String? value) String?
Validates a BIC / SWIFT Code. Returns null if valid, or an error message string if invalid.
validateBloodType(String? value) String?
Validates a Blood Type. Returns null if valid, or an error message string if invalid.
validateBMI(String? value) String?
Validates a Body Mass Index (BMI). Returns null if valid, or an error message string if invalid.
validateCity(String? value) String?
Validates a City Name. Returns null if valid, or an error message string if invalid.
validateContainerNumber(String? value) String?
Validates a Container Number. Returns null if valid, or an error message string if invalid.
validateCountry(String? value) String?
Validates a Country Name. Returns null if valid, or an error message string if invalid.
validateCountryCode(String? value) String?
Validates a Country Code according to ISO 3166-1 alpha-2. Returns null if valid, or an error message string if invalid.
validateCouponCode(String? value) String?
Validates a Coupon Code. Returns null if valid, or an error message string if invalid.
validateCourseCode(String? value) String?
Validates a Course Code. Returns null if valid, or an error message string if invalid.
validateCreditCardNumber(String? value) String?
Validates a Credit Card Number. Returns null if valid, or an error message string if invalid.
validateCSVFormat(String? value) String?
Validates if the input string is in valid CSV format. This is a basic implementation and might need adjustments for specific CSV rules.
validateCurrencyCode(String? value) String?
Validates a Currency Code according to ISO 4217. Returns null if valid, or an error message string if invalid.
validateCurrencyFormat(String? value) String?
Validates a Currency Format. Returns null if valid, or an error message string if invalid.
validateCVV(String? value) String?
Validates a CVV (Card Verification Value). Returns null if valid, or an error message string if invalid.
validateDate(String? value) String?
Validates if the input string conforms to the YYYY-MM-DD date format. Returns null if valid, or an error message string if invalid.
validateDateOfBirth(String? value) String?
Validates a Date of Birth. Returns null if valid, or an error message string if invalid.
validateDepartmentCode(String? value) String?
Validates a Department Code. Returns null if valid, or an error message string if invalid.
validateDomainName(String? value) String?
Validates a Domain Name. Returns null if valid, or an error message string if invalid.
validateDriversLicenseNumber(String? value) String?
Validates a Driver's License Number. Returns null if valid, or an error message string if invalid.
validateEmailAddress(String? value) String?
Validates an Email Address. Returns null if valid, or an error message string if invalid.
validateEmailLocalPart(String? value) String?
Validates the Local Part of an Email. Returns null if valid, or an error message string if invalid.
validateEmployeeID(String? value) String?
Validates an Employee ID. Returns null if valid, or an error message string if invalid.
validateExpirationDate(String? value) String?
Validates an Expiration Date (MM/YY). Returns null if valid, or an error message string if invalid.
validateFileExtension(String? value, List<String> allowedExtensions) String?
Validates the file extension against a list of allowed extensions. Returns null if valid, or an error message string if invalid.
validateFileName(String? value) String?
Validates if the input string is a valid file name. Returns null if valid, or an error message string if invalid.
validateFilePath(String? value) String?
Validates the file path structure. Returns null if valid, or an error message string if invalid.
validateFileSize(int size, int minSize, int maxSize) String?
Validates if the file size (in bytes) is within a given range. This function would typically be used in conjunction with file selection inputs. The size parameter should represent the file size in bytes. Returns null if valid, or an error message string if invalid.
validateFirstName(String? value) String?
Validates a First Name. Returns null if valid, or an error message string if invalid.
validateFiscalYear(String? value) String?
Validates if the input string is a valid fiscal year. Returns null if valid, or an error message string if invalid.
validateFullName(String? value) String?
Validates a Full Name. Returns null if valid, or an error message string if invalid.
validateGiftCardCode(String? value) String?
Validates a Gift Card Code. Returns null if valid, or an error message string if invalid.
validateGPA(String? value) String?
Validates a GPA (Grade Point Average). Returns null if valid, or an error message string if invalid.
validateGradeLevel(String? value) String?
Validates a Grade Level. Returns null if valid, or an error message string if invalid.
validateHazardousMaterialsCode(String? value) String?
Validates Hazardous Materials Code. Returns null if valid, or an error message string if invalid.
validateHealthInsurancePolicyNumber(String? value) String?
Validates a Health Insurance Policy Number. Returns null if valid, or an error message string if invalid.
validateHEXColorCode(String? value) String?
Validates a HEX Color Code. Returns null if valid, or an error message string if invalid.
validateHTMLContent(String? value) String?
Validates if the input string is valid HTML content. Returns null if valid, or an error message string if invalid.
validateIBAN(String? value) String?
Validates an IBAN (International Bank Account Number). Returns null if valid, or an error message string if invalid.
validateIPv4Address(String? value) String?
Validates an IPv4 Address. Returns null if valid, or an error message string if invalid.
validateIPv6Address(String? value) String?
Validates an IPv6 Address. Returns null if valid, or an error message string if invalid.
validateISBN(String? value) String?
Validates an ISBN (International Standard Book Number). Returns null if valid, or an error message string if invalid.
validateISSN(String? value) String?
Validates an ISSN (International Standard Serial Number). Returns null if valid, or an error message string if invalid.
validateJobPosition(String? value) String?
Validates a Job Position. This function checks for non-empty input as job positions can vary widely. Returns null if valid, or an error message string if invalid.
validateJSONString(String? value) String?
Validates if the input string is a well-formed JSON. Returns null if valid, or an error message string if invalid.
validateLanguageCode(String? value) String?
Validates a Language Code according to ISO 639-1. Returns null if valid, or an error message string if invalid.
validateLastName(String? value) String?
Validates a Last Name. Returns null if valid, or an error message string if invalid.
validateLatitudeLongitude(String? value) String?
Validates Latitude and Longitude. Returns null if valid, or an error message string if invalid.
validateLicensePlate(String? value) String?
Validates a License Plate. This is a basic validation and may need to be adjusted based on country-specific formats.
validateLoyaltyCardNumber(String? value) String?
Validates a Loyalty Card Number. Returns null if valid, or an error message string if invalid.
validateMACAddress(String? value) String?
Validates a MAC Address. Returns null if valid, or an error message string if invalid.
validateMarkdown(String? value) String?
Validates if the input string is valid Markdown content. This function is permissive as Markdown can be plain text with specific symbols.
validateMedicalRecordNumber(String? value) String?
Validates a Medical Record Number. Returns null if valid, or an error message string if invalid.
validateMilitaryRank(String? value) String?
Validates Military Rank. Returns null if valid, or an error message string if invalid.
validateMonth(String? value) String?
Validates if the input string is a valid month. Returns null if valid, or an error message string if invalid.
validateNationalID(String? value) String?
Validates a National Identification Number. Returns null if valid, or an error message string if invalid.
validateOrderNumber(String? value) String?
Validates an Order Number. Returns null if valid, or an error message string if invalid.
validatePassportNumber(String? value) String?
Validates a Passport Number. Returns null if valid, or an error message string if invalid.
validatePassword(String? value) String?
Validates a Password. Returns null if valid, or an error message string if invalid.
validatePasswordConfirmation(String? password, String? confirmPassword) String?
Validates Password Confirmation. Compares two passwords for equality. Returns null if valid, or an error message string if invalid.
validatePasswordStrength(String? value) String?
Validates Password Strength. Returns null if valid, or an error message string if invalid.
validatePatentNumber(String? value) String?
Validates a Patent Number. Returns null if valid, or an error message string if invalid.
validatePercentage(String? value) String?
Validates a Percentage. Returns null if valid, or an error message string if invalid.
validatePhoneNumber(String? value) String?
Validates a Phone Number. Returns null if valid, or an error message string if invalid.
validatePlainText(String? value) String?
Validates if the input string is plain text without any specific format. This function is quite permissive, as plain text can include nearly anything.Returns null if valid, or an error message string if invalid.
validatePoliticalDistrict(String? value) String?
Validates Political District. Returns null if valid, or an error message string if invalid.
validatePrescriptionNumber(String? value) String?
Validates a Prescription Number. Returns null if valid, or an error message string if invalid.
validateProductSKU(String? value) String?
Validates a Product SKU (Stock Keeping Unit). Returns null if valid, or an error message string if invalid.
validateQRCode(String? value) String?
Validates a QR Code. Returns null if valid, or an error message string if invalid.
validateQuantity(String? value) String?
Validates a Quantity. Returns null if valid, or an error message string if invalid.
validateRegularExpression(String? value) String?
Validates if the input string is a valid regular expression. Returns null if valid, or an error message string if invalid.
validateRFIDTag(String? value) String?
Validates an RFID Tag. Returns null if valid, or an error message string if invalid.
validateRichText(String? value) String?
Validates if the input string is rich text, typically containing formatting such as HTML. This is a basic check and might need to be more sophisticated based on your rich text specifications.
validateRoutingNumber(String? value) String?
Validates a Routing Number. Returns null if valid, or an error message string if invalid.
validateShippingTrackingNumber(String? value) String?
Validates a Shipping Tracking Number. Returns null if valid, or an error message string if invalid.
validateSQLQuery(String? value) String?
Validates if the input string is a valid SQL query. This is a very basic check and might not suit all SQL dialects.
validateStateProvince(String? value) String?
Validates a State or Province Name. Returns null if valid, or an error message string if invalid.
validateStreetAddress(String? value) String?
Validates a Street Address. Returns null if valid, or an error message string if invalid.
validateStudentID(String? value) String?
Validates a Student ID. Returns null if valid, or an error message string if invalid.
validateTaxIDSSN(String? value) String?
Validates a Tax ID / Social Security Number (SSN). Returns null if valid, or an error message string if invalid.
validateTicketNumber(String? value) String?
Validates a Ticket Number. Returns null if valid, or an error message string if invalid.
validateTimeHHMM(String? value) String?
Validates if the input string conforms to the HH:MM 24-hour time format. Returns null if valid, or an error message string if invalid.
validateTimeHHMMSS(String? value) String?
Validates if the input string conforms to the HH:MM:SS 24-hour time format. Returns null if valid, or an error message string if invalid.
validateTimestamp(String? value) String?
Validates if the input string is a valid timestamp. Returns null if valid, or an error message string if invalid.
validateTimeZone(String? value) String?
Validates if the input string is a recognized time zone format. Returns null if valid, or an error message string if invalid.
validateTrademarkSerial(String? value) String?
Validates a Trademark Serial. Returns null if valid, or an error message string if invalid.
validateURL(String? value) String?
Validates a URL. Returns null if valid, or an error message string if invalid.
validateUruguayanID(String? value) String?
Validates an Uruguayan Identification Number (Cédula de Identidad). Returns null if valid, or an error message string if invalid.
validateUsername(String? value) String?
Validates a Username. Returns null if valid, or an error message string if invalid.
validateUsernameSocialMedia(String? value) String?
Validates a Username for Social Media. Returns null if valid, or an error message string if invalid.
validateUUID(String? value) String?
Validates a UUID (Universally Unique Identifier). Returns null if valid, or an error message string if invalid.
validateVehicleMakeAndModel(String? value) String?
Validates Vehicle Make and Model. This function checks for non-empty input as formats can vary widely. Returns null if valid, or an error message string if invalid.
validateVIN(String? value) String?
Validates a Vehicle Identification Number (VIN). Returns null if valid, or an error message string if invalid.
validateWeekday(String? value) String?
Validates if the input string is a valid weekday. Returns null if valid, or an error message string if invalid.
validateXMLString(String? value) String?
Validates if the input string is a well-formed XML. Returns null if valid, or an error message string if invalid.
validateYear(String? value) String?
Validates if the input string is a valid year. Returns null if valid, or an error message string if invalid.
validateZIPPlus4(String? value) String?
Validates a ZIP+4 Code. Returns null if valid, or an error message string if invalid.
validateZipPostalCode(String? value) String?
Validates a ZIP or Postal Code. Returns null if valid, or an error message string if invalid.