Typewriter v0.7 | Dynamic Variables

.gitattributes

@@ -1,2 +1,3 @@
 # Auto detect text files and perform LF normalization
-* text=auto
+/extensions/_DocsExtension/**/*.kt text eol=lf
+* text=auto

README.md

@@ -20,7 +20,7 @@ For detailed setup instructions, visit the [Installation Guide](https://docs.typ
 
 ### Sponsors
 
-<!-- sponsors --><!-- sponsors -->
+<!-- sponsors --><a href="https://github.com/myiume"><img src="https:&#x2F;&#x2F;avatars.githubusercontent.com&#x2F;u&#x2F;3586926?u&#x3D;3db6af564b6ef85fa06122661bd686188c016e56&amp;v&#x3D;4" width="60px" alt="Myiume" /></a><a href="https://github.com/blue-dev00"><img src="https:&#x2F;&#x2F;avatars.githubusercontent.com&#x2F;u&#x2F;174703443?v&#x3D;4" width="60px" alt="" /></a><a href="https://github.com/JesusRuescas"><img src="https:&#x2F;&#x2F;avatars.githubusercontent.com&#x2F;u&#x2F;12575781?u&#x3D;739fc50505f7ad93508f95161948606f61c8f516&amp;v&#x3D;4" width="60px" alt="Jesus Ruescas Junior" /></a><a href="https://github.com/AllayRPG"><img src="https:&#x2F;&#x2F;avatars.githubusercontent.com&#x2F;u&#x2F;132414911?u&#x3D;8c58ae3c38e719740962b39c7694c1dc8435d962&amp;v&#x3D;4" width="60px" alt="Farkaaas" /></a><!-- sponsors -->
 
 Thanks to the following sponsors for supporting this project. Without their support, this project would not be possible. If you are using Typewriter for your server, and are making money from it, please consider [sponsoring](https://github.com/sponsors/gabber235) the project.
 

app/build.yaml

@@ -0,0 +1,23 @@
+targets:
+  $default:
+    builders:
+      json_serializable:
+        options:
+          # Options configure how source code is generated for every
+          # `@JsonSerializable`-annotated class in the package.
+          #
+          # The default value for each is listed.
+          any_map: false
+          checked: false
+          constructor: ""
+          create_factory: true
+          create_field_map: false
+          create_json_keys: false
+          create_per_field_to_json: false
+          create_to_json: true
+          disallow_unrecognized_keys: false
+          explicit_to_json: true
+          field_rename: none
+          generic_argument_factories: false
+          ignore_unannotated: false
+          include_if_null: true

app/lib/app_router.dart

@@ -2,6 +2,7 @@ import "dart:async";
 
 import "package:auto_route/auto_route.dart";
 import "package:flutter/material.dart";
+import "package:hooks_riverpod/hooks_riverpod.dart";
 import "package:riverpod_annotation/riverpod_annotation.dart";
 import "package:typewriter/guard/connected_guard.dart";
 import "package:typewriter/models/page.dart";
@@ -85,7 +86,7 @@ class InvalidatorNavigatorObserver extends NavigatorObserver {
 
 /// Provides the current route data for the given [name].
 @Riverpod(keepAlive: true)
-RouteData? currentRouteData(CurrentRouteDataRef ref, String path) {
+RouteData? currentRouteData(Ref ref, String path) {
   final router = ref.watch(appRouter);
   return _fetchCurrentRouteData(path, router);
 }

app/lib/hooks/delayed_execution.dart

@@ -17,7 +17,8 @@ class _DelayedExecutionHook extends Hook<void> {
   _DelayedExecutionHookState createState() => _DelayedExecutionHookState();
 }
 
-class _DelayedExecutionHookState extends HookState<void, _DelayedExecutionHook> {
+class _DelayedExecutionHookState
+    extends HookState<void, _DelayedExecutionHook> {
   void _run() {
     WidgetsBinding.instance.addPostFrameCallback((_) => hook.function());
   }

app/lib/hooks/staggered_animation_controllers.dart

@@ -0,0 +1,110 @@
+import "dart:async";
+
+import "package:flutter/material.dart";
+import "package:flutter_hooks/flutter_hooks.dart";
+
+/// Run multiple animation staggered from each other.
+List<AnimationController> useStaggeredAnimationControllers({
+  required int count,
+  required Duration duration,
+  required Duration interval,
+  required TickerProvider vsync,
+  bool autoPlay = true,
+}) {
+  return use(
+    _StaggeredAnimationControllersHook(
+      count,
+      duration,
+      interval,
+      vsync,
+      autoPlay: autoPlay,
+    ),
+  );
+}
+
+class _StaggeredAnimationControllersHook
+    extends Hook<List<AnimationController>> {
+  const _StaggeredAnimationControllersHook(
+    this.count,
+    this.duration,
+    this.interval,
+    this.vsync, {
+    required this.autoPlay,
+  });
+
+  final int count;
+  final Duration duration;
+  final Duration interval;
+  final bool autoPlay;
+  final TickerProvider vsync;
+
+  @override
+  _StaggeredAnimationControllersHookState createState() =>
+      _StaggeredAnimationControllersHookState();
+}
+
+class _StaggeredAnimationControllersHookState extends HookState<
+    List<AnimationController>, _StaggeredAnimationControllersHook> {
+  List<AnimationController> controllers = [];
+  Timer? timer;
+  int index = 0;
+
+  void _animate() {
+    if (!hook.autoPlay) {
+      return;
+    }
+    if (timer != null) {
+      return;
+    }
+    if (index >= hook.count) {
+      return;
+    }
+    timer = Timer.periodic(hook.interval, (timer) {
+      controllers[index].forward();
+      index = index + 1;
+      if (index >= hook.count) {
+        timer.cancel();
+        this.timer = null;
+      }
+    });
+  }
+
+  void _updateControllers() {
+    while (controllers.length > hook.count) {
+      controllers.removeLast();
+    }
+
+    while (controllers.length < hook.count) {
+      controllers.add(
+        AnimationController(
+          duration: hook.duration,
+          vsync: hook.vsync,
+        ),
+      );
+
+      if (index >= controllers.length) {
+        index = controllers.length - 1;
+      }
+    }
+  }
+
+  @override
+  void initHook() {
+    _updateControllers();
+    _animate();
+    super.initHook();
+  }
+
+  @override
+  List<AnimationController> build(BuildContext context) {
+    _updateControllers();
+    _animate();
+    return controllers;
+  }
+
+  @override
+  void dispose() {
+    timer?.cancel();
+    super.dispose();
+  }
+}

app/lib/models/communicator.dart

@@ -41,7 +41,7 @@ final socketProvider = StateNotifierProvider<SocketNotifier, Socket?>(
 class SocketNotifier extends StateNotifier<Socket?> {
   SocketNotifier(this.ref) : super(null);
 
-  final StateNotifierProviderRef<SocketNotifier, Socket?> ref;
+  final Ref ref;
   bool _disposed = false;
 
   /// When a socket gets disconnected, we want to try to reconnect it.
@@ -235,13 +235,13 @@ class SocketNotifier extends StateNotifier<Socket?> {
 }
 
 @Riverpod(keepAlive: true)
-Communicator communicator(CommunicatorRef ref) => Communicator(ref);
+Communicator communicator(Ref ref) => Communicator(ref);
 
 @immutable
 class Communicator {
   const Communicator(this.ref);
 
-  final CommunicatorRef ref;
+  final Ref ref;
 
   Future<void> fetchBook() async {
     final socket = ref.read(socketProvider);

app/lib/models/entry.dart

@@ -1,6 +1,7 @@
 import "dart:convert";
 
 import "package:collection/collection.dart";
+import "package:hooks_riverpod/hooks_riverpod.dart";
 import "package:riverpod_annotation/riverpod_annotation.dart";
 import "package:typewriter/models/entry_blueprint.dart";
 import "package:typewriter/models/page.dart";
@@ -11,7 +12,7 @@ part "entry.g.dart";
 
 @riverpod
 EntryDefinition? entryDefinition(
-  EntryDefinitionRef ref,
+  Ref ref,
   String entryId,
 ) {
   final page = ref.watch(entryPageProvider(entryId));
@@ -32,21 +33,30 @@ EntryDefinition? entryDefinition(
 }
 
 @riverpod
-String? entryName(EntryNameRef ref, String entryId) {
+String? entryName(Ref ref, String entryId) {
   final entry = ref.watch(globalEntryProvider(entryId));
   return entry?.formattedName;
 }
 
 @riverpod
-String? entryBlueprintId(EntryBlueprintIdRef ref, String entryId) {
+String? entryBlueprintId(Ref ref, String entryId) {
   final entry = ref.watch(globalEntryProvider(entryId));
   return entry?.blueprintId;
 }
 
 @riverpod
-bool isEntryDeprecated(IsEntryDeprecatedRef ref, String entryId) {
-  final entryTags = ref.watch(entryTagsProvider(entryId));
-  return entryTags.contains("deprecated");
+DeprecatedModifier? entryDeprecated(Ref ref, String entryId) {
+  final blueprintId = ref.watch(entryBlueprintIdProvider(entryId));
+  if (blueprintId == null) return null;
+  final blueprint = ref.watch(entryBlueprintProvider(blueprintId));
+  if (blueprint == null) return null;
+  return blueprint.modifiers.whereType<DeprecatedModifier>().firstOrNull;
+}
+
+@riverpod
+bool isEntryDeprecated(Ref ref, String entryId) {
+  final deprecated = ref.watch(entryDeprecatedProvider(entryId));
+  return deprecated != null;
 }
 
 class EntryDefinition {
@@ -74,15 +84,28 @@ class Entry {
   Entry.fromBlueprint({
     required String id,
     required EntryBlueprint blueprint,
-  }) : data = {
+    DataBlueprint? genericBlueprint,
+  })  : assert(
+          blueprint.isGeneric == (genericBlueprint != null),
+          blueprint.isGeneric
+              ? "Blueprint is generic but no generic blueprint was provided"
+              : "Blueprint is not generic but a generic blueprint was provided",
+        ),
+        assert(
+          blueprint.allowsGeneric(genericBlueprint),
+          "Generic blueprint given is not allowed for this blueprint, blueprint: ${blueprint.id}, allowed: ${blueprint.genericConstraints}, genericBlueprint: $genericBlueprint",
+        ),
+        data = {
           ...blueprint.dataBlueprint.defaultValue(),
           "id": id,
           "name": "new_${blueprint.name}",
           "type": blueprint.id,
+          "_genericBlueprint": genericBlueprint?.toJson(),
         };
 
   factory Entry.fromJson(Map<String, dynamic> json) => Entry(json);
   final Map<String, dynamic> data;
+  DataBlueprint? _genericBlueprint;
 
   Map<String, dynamic> toJson() => data;
 
@@ -102,6 +125,21 @@ class Entry {
     throw Exception("Could not find blueprint id or type in entry data");
   }
 
+  /// Returns the generic blueprint of the entry.
+  DataBlueprint? get genericBlueprint {
+    if (_genericBlueprint != null) return _genericBlueprint;
+    final genericBlueprint = data["_genericBlueprint"];
+    if (genericBlueprint == null) return null;
+
+    if (genericBlueprint is! Map<String, dynamic>) {
+      throw Exception("Generic blueprint is not a map");
+    }
+
+    final blueprint = DataBlueprint.fromJson(genericBlueprint);
+    _genericBlueprint = blueprint;
+    return blueprint;
+  }
+
   /// Returns the values in [map] that match [path].
   ///
   /// The path is a string representation of keys and indices to access the values in [map].