Separated vanilla flutter & the flutter_hooks version of the package 😢

CHANGELOGS created for both package
This commit is contained in:
Kingkor Roy Tirtho
2022-07-08 03:48:04 +06:00
parent 8563abf117
commit 4afaa4b471
30 changed files with 535 additions and 24 deletions
@@ -1,83 +0,0 @@
import 'package:fl_query/src/models/mutation_job.dart';
import 'package:fl_query/src/mutation.dart';
import 'package:fl_query/src/query_bowl.dart';
import 'package:fl_query/src/utils.dart';
import 'package:flutter/widgets.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
Mutation<T, V> useMutation<T extends Object, V>({
required MutationJob<T, V> job,
/// Called when the query returns new data, on query
/// refetch or query gets expired
MutationListener<T>? onData,
/// Called when the query returns error
MutationListener<dynamic>? onError,
/// called right before the mutation is about to run
///
/// perfect scenario for doing optimistic updates
MutationListener<V>? onMutate,
List<Object?>? keys,
}) {
final context = useContext();
final QueryBowl queryBowl = QueryBowl.of(context);
final ValueKey<String> uKey = useMemoized(() => ValueKey(uuid.v4()), []);
final mutation =
useRef(Mutation<T, V>.fromOptions(job, queryBowl: queryBowl));
final init = useCallback(() {
mutation.value = queryBowl.addMutation<T, V>(
mutation.value,
onData: onData,
onError: onError,
onMutate: onMutate,
key: uKey,
);
}, [mutation.value, job, onData, onError, onMutate, uKey]);
final disposeMutation = useCallback(() {
mutation.value.unmount(uKey);
if (onData != null) mutation.value.onDataListeners.remove(onData);
if (onError != null) mutation.value.onErrorListeners.remove(onError);
if (onMutate != null) mutation.value.onMutateListeners.remove(onMutate);
}, [mutation.value, onData, onError, onMutate]);
final oldJob = usePrevious(job);
final oldOnData = usePrevious(onData);
final oldOnError = usePrevious(onError);
final oldOnMutate = usePrevious(onMutate);
useEffect(() {
init();
return disposeMutation;
}, []);
useEffect(() {
if (oldJob != null && oldJob.mutationKey != job.mutationKey) {
disposeMutation();
mutation.value = Mutation<T, V>.fromOptions(
job,
queryBowl: queryBowl,
);
init();
} else {
if (oldOnData != onData && oldOnData != null) {
mutation.value.onDataListeners.remove(oldOnData);
if (onData != null) mutation.value.onDataListeners.add(onData);
}
if (oldOnError != onError && oldOnError != null) {
mutation.value.onErrorListeners.remove(oldOnError);
if (onError != null) mutation.value.onErrorListeners.add(onError);
}
if (oldOnMutate != onMutate && oldOnMutate != null) {
mutation.value.onMutateListeners.remove(oldOnMutate);
if (onMutate != null) mutation.value.onMutateListeners.add(onMutate);
}
}
return null;
});
return queryBowl.getMutation<T, V>(job.mutationKey) ?? mutation.value;
}
@@ -1,109 +0,0 @@
import 'package:fl_query/src/models/query_job.dart';
import 'package:fl_query/src/query.dart';
import 'package:fl_query/src/query_bowl.dart';
import 'package:fl_query/src/utils.dart';
import 'package:flutter/widgets.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
Query<T, Outside> useQuery<T extends Object, Outside>({
required QueryJob<T, Outside> job,
required Outside externalData,
/// Called when the query returns new data, on query
/// refetch or query gets expired
QueryListener<T>? onData,
/// Called when the query returns error
QueryListener<dynamic>? onError,
List<Object?>? keys,
}) {
final context = useContext();
final QueryBowl queryBowl = QueryBowl.of(context);
final ValueKey<String> uKey = useMemoized(() => ValueKey(uuid.v4()), []);
final query = useRef(
Query.fromOptions(
job,
externalData: externalData,
queryBowl: queryBowl,
),
);
final oldJob = usePrevious(job);
final oldExternalData = usePrevious(externalData);
final oldOnData = usePrevious(onData);
final oldOnError = usePrevious(onError);
final init = useCallback(() {
query.value = queryBowl.addQuery<T, Outside>(
query.value,
key: uKey,
onData: onData,
onError: onError,
);
final hasExternalDataChanged = query.value.externalData != null &&
query.value.prevUsedExternalData != null &&
!isShallowEqual(
query.value.externalData!, query.value.prevUsedExternalData!);
(query.value.fetched && query.value.refetchOnMount == true) ||
hasExternalDataChanged
? query.value.refetch()
: query.value.fetch();
}, [queryBowl, query.value, uKey, onData, onError, job]);
final disposeQuery = useCallback(() {
query.value.unmount(uKey);
if (onData != null) query.value.onDataListeners.remove(onData);
if (onError != null) query.value.onErrorListeners.remove(onError);
}, [query.value, onData, onError, uKey]);
useEffect(() {
init();
return disposeQuery;
}, []);
useEffect(() {
final hasOnErrorChanged = oldOnError != onError && oldOnError != null;
final hasOnDataChanged = oldOnData != onData && oldOnData != null;
if (oldJob != null && oldJob.queryKey != job.queryKey) {
disposeQuery();
query.value = Query.fromOptions(
job,
externalData: externalData,
queryBowl: queryBowl,
);
init();
} else if (oldExternalData != null &&
externalData != null &&
!isShallowEqual(oldExternalData, externalData)) {
if (job.refetchOnExternalDataChange ??
queryBowl.refetchOnExternalDataChange) {
QueryBowl.of(context).fetchQuery(
job,
externalData: externalData,
onData: onData,
onError: onError,
key: uKey,
);
} else {
QueryBowl.of(context)
.getQuery(job.queryKey)
?.setExternalData(externalData);
}
if (hasOnDataChanged) query.value.onDataListeners.remove(oldOnData);
if (hasOnErrorChanged) query.value.onErrorListeners.remove(oldOnError);
} else {
if (hasOnDataChanged) {
query.value.onDataListeners.remove(oldOnData);
if (onData != null) query.value.onDataListeners.add(onData);
}
if (hasOnErrorChanged) {
query.value.onErrorListeners.remove(oldOnError);
if (onError != null) query.value.onErrorListeners.add(onError);
}
}
return null;
});
return queryBowl.getQuery<T, Outside>(job.queryKey) ?? query.value;
}
@@ -1,7 +1,6 @@
import 'dart:async';
import 'package:connectivity_plus/connectivity_plus.dart';
import 'package:fl_query/fl_query_hooks.dart';
import 'package:fl_query/src/models/query_job.dart';
import 'package:fl_query/src/mutation.dart';
import 'package:fl_query/src/mutation_builder.dart';