chore: move of stacked_core package

Signed-off-by: Christoph Bühler <[email protected]>

Author: Christoph Bühler

CHANGELOG.md

@@ -0,0 +1,27 @@
+## 1.2.4
+
+- Add `instanceName` to DependencyRegistration annotations
+
+## 1.2.3
+
+- Add `bottomsheets` to StackedApp annotations
+
+## 1.2.2
+
+- Adds `autoTextFieldValidation` flag on FormView annotation
+
+## 1.2.1
+
+- Remove unused isPassword field from `FormTextField`
+
+## 1.2.0
+
+- Add `dialogs` to StackedApp annotations
+
+## 1.1.0
+
+- Add ambiguate function
+
+## 1.0.0
+
+- Initial version.

README.md

@@ -1,16 +1,3 @@
-# New Package for Stacked
+# Stacked Core
 
-Created from the `package-template`.
-
-After creating the repository, proceed with the following instructions:
-
-- Update the repository settings to adhere to the conventions:
-  - Allow squash&merge commits.
-  - Suggest update.
-  - Require linear history.
-- Add branch protection rules:
-  - Require pull request reviews before merging.
-  - Require status checks to pass before merging.
-  - Allow the user with the DEPLOY token secret to overwrite pull request.
-- Create the flutter package with `flutter create -t package --project-name NAME .`
-- Update the content in the `README` file.
+This package contains all the code shared between our flutter and pure dart packages to avoid including flutter where it's not required.

analysis_options.yaml

@@ -1,19 +1,30 @@
-include: package:flutter_lints/flutter.yaml
+# This file configures the static analysis results for your project (errors,
+# warnings, and lints).
+#
+# This enables the 'recommended' set of lints from `package:lints`.
+# This set helps identify many issues that may lead to problems when running
+# or consuming Dart code, and enforces writing Dart using a single, idiomatic
+# style and format.
+#
+# If you want a smaller set of lints you can change this to specify
+# 'package:lints/core.yaml'. These are just the most critical lints
+# (the recommended set includes the core lints).
+# The core lints are also what is used by pub.dev for scoring packages.
 
-# TODO: need the input of @FilledStacks here
-linter:
-  rules:
-    always_declare_return_types: true
-    avoid_relative_lib_imports: true
-    eol_at_end_of_file: true
-    library_private_types_in_public_api: false
-    lines_longer_than_80_chars: false
-    prefer_final_fields: true
-    prefer_final_in_for_each: true
-    prefer_final_locals: true
-    prefer_relative_imports: true
-    prefer_single_quotes: true
+include: package:lints/recommended.yaml
 
-analyzer:
-  exclude:
-    - '*.g.dart'
+# Uncomment the following section to specify additional rules.
+
+# linter:
+#   rules:
+#     - camel_case_types
+
+# analyzer:
+#   exclude:
+#     - path/to/excluded/files/**
+
+# For more information about the core and recommended set of lints, see
+# https://dart.dev/go/core-lints
+
+# For additional information about configuring this file, see
+# https://dart.dev/guides/language/analysis-options

example/example.dart

@@ -0,0 +1 @@
+void main() {}

example/stacked_core_example.dart

@@ -0,0 +1,7 @@
+/// This allows a value of type T or T?
+/// to be treated as a value of type T?.
+///
+/// We use this so that APIs that have become
+/// non-nullable can still be used with `!` and `?`
+/// to support older versions of the API as well.
+T? ambiguate<T>(T? value) => value;

lib/src/backward_compatibility/flutter_v2_compatibility.dart

@@ -0,0 +1,13 @@
+/// Described the Bottomsheet functionality to generate in the app
+class StackedBottomsheet {
+  /// Pass Bottomsheets types here.
+  ///
+  /// bottomsheets classes should have two named parameters:
+  /// 1. request of type [BottomsheetRequest]
+  /// 2. completer of type [void Function(BottomsheetResponse)]
+  final Type classType;
+
+  const StackedBottomsheet({
+    required this.classType,
+  });
+}

lib/src/code_generation/bottomsheets/stacked_bottomsheet.dart

@@ -0,0 +1,13 @@
+/// Described the Dialog functionality to generate in the app
+class StackedDialog {
+  /// Pass Dialogs types here.
+  ///
+  /// dialogs classes should have two named parameters:
+  /// 1. request of type [DialogRequest]
+  /// 2. completer of type [void Function(DialogResponse)]
+  final Type classType;
+
+  const StackedDialog({
+    required this.classType,
+  });
+}

lib/src/code_generation/dialogs/stacked_dialog.dart

@@ -0,0 +1,70 @@
+/// a simple filter function to be used inside [SimpleEnvironmentFilter]
+typedef EnvironmentFilterFunc = bool Function(Set<String>);
+const kEnvironmentsName = '__environments__';
+
+/// filter for whether to register for the given set of environments
+/// clients can extend this class to maker
+/// their own environmentFilters
+abstract class EnvironmentFilter {
+  /// holds passed environment keys
+  /// to be used inside the filter or
+  /// retrieved later by users
+  final Set<String?> environments;
+
+  /// default constructor
+  const EnvironmentFilter(this.environments);
+
+  /// This function is called before every
+  /// registration call, if it returns true, the dependency
+  /// will be registered otherwise, it will be ignored
+  bool canRegister(Set<String> depEnvironments);
+}
+
+///  A simple filter that can be used directly for simple use cases
+///  without having to extend the base [EnvironmentFilter]
+class SimpleEnvironmentFilter extends EnvironmentFilter {
+  final EnvironmentFilterFunc filter;
+
+  const SimpleEnvironmentFilter(
+      {required this.filter, Set<String> environments = const {}})
+      : super(environments);
+
+  @override
+  bool canRegister(Set<String> depEnvironments) => filter(depEnvironments);
+}
+
+/// This filter validates dependencies with no environment
+/// keys or contain the provided [environment]
+class NoEnvOrContains extends EnvironmentFilter {
+  NoEnvOrContains(String? environment) : super({environment});
+
+  @override
+  bool canRegister(Set<String> depEnvironments) {
+    return (depEnvironments.isEmpty) ||
+        depEnvironments.contains(environments.first);
+  }
+}
+
+/// This filter validates dependencies with no environment
+/// keys, or the ones containing all the provided [environments]
+class NoEnvOrContainsAll extends EnvironmentFilter {
+  const NoEnvOrContainsAll(Set<String> environments) : super(environments);
+
+  @override
+  bool canRegister(Set<String> depEnvironments) {
+    return (depEnvironments.isEmpty) ||
+        depEnvironments.containsAll(environments);
+  }
+}
+
+/// This filter validates dependencies with no environment
+/// keys, or the ones containing one of the provided [environments]
+class NoEnvOrContainsAny extends EnvironmentFilter {
+  const NoEnvOrContainsAny(Set<String> environments) : super(environments);
+
+  @override
+  bool canRegister(Set<String> depEnvironments) {
+    return (depEnvironments.isEmpty) ||
+        depEnvironments.intersection(environments).isNotEmpty;
+  }
+}

lib/src/code_generation/environment_filter.dart

@@ -0,0 +1,58 @@
+/// The annotation to be used for a view that contains a Form
+class FormView {
+  /// The list of form fields to generate
+  final List<FormField>? fields;
+
+  /// A flag to enable/disable auto validation of text fields. defauls to `true`
+  final bool autoTextFieldValidation;
+  const FormView({
+    this.fields,
+    this.autoTextFieldValidation = true,
+  });
+}
+
+/// Describes a form field to be generated
+class FormField {
+  /// The name of the form field. This will be used to generate the Key mapping
+  final String? name;
+
+  const FormField({this.name});
+}
+
+/// Describes an entry field on the form that takes text
+class FormTextField extends FormField {
+  /// Assigns initial value, `text` parameter in `TextEditingController`
+  final String? initialValue;
+
+  final String? Function(String?)? validator;
+
+  /// Replace the default flutter [TextEditingController] with
+  /// another controller that extends the [TextEditingController]
+  ///
+  /// When providing this field [initialValue] will be ignored
+  final dynamic Function()? customTextEditingController;
+
+  const FormTextField({
+    String? name,
+    this.initialValue,
+    this.validator,
+    this.customTextEditingController,
+  }) : super(name: name);
+}
+
+/// Describes a date form field.
+class FormDateField extends FormField {
+  const FormDateField({String? name}) : super(name: name);
+}
+
+class FormDropdownField extends FormField {
+  final List<StaticDropdownItem> items;
+  const FormDropdownField({String? name, required this.items})
+      : super(name: name);
+}
+
+class StaticDropdownItem {
+  final String title;
+  final String value;
+  const StaticDropdownItem({required this.title, required this.value});
+}