From 4afaa4b4718f6bb51a22c4b588c933c82d66b5a8 Mon Sep 17 00:00:00 2001 From: Kingkor Roy Tirtho Date: Fri, 8 Jul 2022 03:48:04 +0600 Subject: [PATCH] Separated vanilla flutter & the flutter_hooks version of the package :cry: CHANGELOGS created for both package --- README.md | 1 + docs/docs/getting-started/installation.md | 3 +- .../components/hooks/basic_hook_mutation.dart | 2 +- .../components/hooks/basic_hook_query.dart | 2 +- .../lib/components/hooks/lazy_hook_query.dart | 2 +- .../hooks/mutation_hook_variable_key.dart | 2 +- .../hooks/query_hook_external_data.dart | 2 +- .../hooks/query_hook_variable_key.dart | 2 +- packages/example/pubspec.lock | 11 +- packages/example/pubspec.yaml | 2 + .../fl_query/.flutter-plugins-dependencies | 2 +- packages/fl_query/CHANGELOG.md | 11 + packages/fl_query/LICENSE | 201 ++++++++++++++++++ packages/fl_query/lib/fl_query.dart | 1 + packages/fl_query/lib/fl_query_hooks.dart | 4 - packages/fl_query/lib/src/query_bowl.dart | 1 - packages/fl_query/pubspec.yaml | 2 +- packages/fl_query_hooks/.flutter-plugins | 6 + .../.flutter-plugins-dependencies | 1 + packages/fl_query_hooks/.gitignore | 30 +++ packages/fl_query_hooks/.metadata | 10 + packages/fl_query_hooks/CHANGELOG.md | 8 + packages/fl_query_hooks/LICENSE | 201 ++++++++++++++++++ packages/fl_query_hooks/README.md | 3 + .../fl_query_hooks/lib/fl_query_hooks.dart | 4 + .../lib/src}/use_mutation.dart | 6 +- .../lib/src}/use_query.dart | 6 +- packages/fl_query_hooks/lib/src/utils.dart | 3 + packages/fl_query_hooks/pubspec.yaml | 25 +++ .../test/fl_query_hooks_test.dart | 5 + 30 files changed, 535 insertions(+), 24 deletions(-) create mode 100644 packages/fl_query/CHANGELOG.md create mode 100644 packages/fl_query/LICENSE delete mode 100644 packages/fl_query/lib/fl_query_hooks.dart create mode 100644 packages/fl_query_hooks/.flutter-plugins create mode 100644 packages/fl_query_hooks/.flutter-plugins-dependencies create mode 100644 packages/fl_query_hooks/.gitignore create mode 100644 packages/fl_query_hooks/.metadata create mode 100644 packages/fl_query_hooks/CHANGELOG.md create mode 100644 packages/fl_query_hooks/LICENSE create mode 100644 packages/fl_query_hooks/README.md create mode 100644 packages/fl_query_hooks/lib/fl_query_hooks.dart rename packages/{fl_query/lib/src/hooks => fl_query_hooks/lib/src}/use_mutation.dart (93%) rename packages/{fl_query/lib/src/hooks => fl_query_hooks/lib/src}/use_query.dart (94%) create mode 100644 packages/fl_query_hooks/lib/src/utils.dart create mode 100644 packages/fl_query_hooks/pubspec.yaml create mode 100644 packages/fl_query_hooks/test/fl_query_hooks_test.dart diff --git a/README.md b/README.md index 83020d2..cb75822 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ For elite flutter_hooks user: ```bash $ flutter pub add flutter_hooks +$ flutter pub add fl_query_hooks ``` # Docs diff --git a/docs/docs/getting-started/installation.md b/docs/docs/getting-started/installation.md index e5012f8..ca30f4b 100644 --- a/docs/docs/getting-started/installation.md +++ b/docs/docs/getting-started/installation.md @@ -11,9 +11,10 @@ $ flutter pub add fl_query ### For using with `flutter_hooks` -If you're an ELITE `flutter_hooks` user or want to use `fl_query_hooks` you'll only need the `flutter_hooks` package & nothing else +If you're an ELITE `flutter_hooks` user or want to use `fl_query_hooks` you'll need the `flutter_hooks` & `fl_query_hooks` package ```bash +$ flutter pub add fl_query_hooks $ flutter pub add flutter_hooks ``` diff --git a/packages/example/lib/components/hooks/basic_hook_mutation.dart b/packages/example/lib/components/hooks/basic_hook_mutation.dart index 6e6541f..2d7ba3b 100644 --- a/packages/example/lib/components/hooks/basic_hook_mutation.dart +++ b/packages/example/lib/components/hooks/basic_hook_mutation.dart @@ -2,7 +2,7 @@ import 'dart:convert'; import 'dart:math'; import 'package:example/components/hooks/basic_hook_query.dart'; -import 'package:fl_query/fl_query_hooks.dart'; +import 'package:fl_query_hooks/fl_query_hooks.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:http/http.dart' as http; diff --git a/packages/example/lib/components/hooks/basic_hook_query.dart b/packages/example/lib/components/hooks/basic_hook_query.dart index 9173b1d..15f73ed 100644 --- a/packages/example/lib/components/hooks/basic_hook_query.dart +++ b/packages/example/lib/components/hooks/basic_hook_query.dart @@ -1,7 +1,7 @@ import 'dart:math'; import 'package:fl_query/fl_query.dart'; -import 'package:fl_query/fl_query_hooks.dart'; +import 'package:fl_query_hooks/fl_query_hooks.dart'; import 'package:flutter/material.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; diff --git a/packages/example/lib/components/hooks/lazy_hook_query.dart b/packages/example/lib/components/hooks/lazy_hook_query.dart index d5bb75e..3938422 100644 --- a/packages/example/lib/components/hooks/lazy_hook_query.dart +++ b/packages/example/lib/components/hooks/lazy_hook_query.dart @@ -1,5 +1,5 @@ import 'package:fl_query/fl_query.dart'; -import 'package:fl_query/fl_query_hooks.dart'; +import 'package:fl_query_hooks/fl_query_hooks.dart'; import 'package:flutter/material.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; diff --git a/packages/example/lib/components/hooks/mutation_hook_variable_key.dart b/packages/example/lib/components/hooks/mutation_hook_variable_key.dart index 14a1795..bae91de 100644 --- a/packages/example/lib/components/hooks/mutation_hook_variable_key.dart +++ b/packages/example/lib/components/hooks/mutation_hook_variable_key.dart @@ -1,7 +1,7 @@ import 'dart:math'; import 'package:fl_query/fl_query.dart'; -import 'package:fl_query/fl_query_hooks.dart'; +import 'package:fl_query_hooks/fl_query_hooks.dart'; import 'package:flutter/material.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; diff --git a/packages/example/lib/components/hooks/query_hook_external_data.dart b/packages/example/lib/components/hooks/query_hook_external_data.dart index ed75228..8ada29f 100644 --- a/packages/example/lib/components/hooks/query_hook_external_data.dart +++ b/packages/example/lib/components/hooks/query_hook_external_data.dart @@ -1,7 +1,7 @@ import 'dart:math'; import 'package:fl_query/fl_query.dart'; -import 'package:fl_query/fl_query_hooks.dart'; +import 'package:fl_query_hooks/fl_query_hooks.dart'; import 'package:flutter/material.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; diff --git a/packages/example/lib/components/hooks/query_hook_variable_key.dart b/packages/example/lib/components/hooks/query_hook_variable_key.dart index 41707ed..66e59a0 100644 --- a/packages/example/lib/components/hooks/query_hook_variable_key.dart +++ b/packages/example/lib/components/hooks/query_hook_variable_key.dart @@ -1,7 +1,7 @@ import 'dart:math'; import 'package:fl_query/fl_query.dart'; -import 'package:fl_query/fl_query_hooks.dart'; +import 'package:fl_query_hooks/fl_query_hooks.dart'; import 'package:flutter/material.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; diff --git a/packages/example/pubspec.lock b/packages/example/pubspec.lock index 8ca63f7..ee54224 100644 --- a/packages/example/pubspec.lock +++ b/packages/example/pubspec.lock @@ -133,7 +133,14 @@ packages: path: "../fl_query" relative: true source: path - version: "0.0.1" + version: "0.1.0" + fl_query_hooks: + dependency: "direct main" + description: + path: "../fl_query_hooks" + relative: true + source: path + version: "0.1.0" flutter: dependency: "direct main" description: flutter @@ -145,7 +152,7 @@ packages: name: flutter_hooks url: "https://pub.dartlang.org" source: hosted - version: "0.18.5" + version: "0.18.5+1" flutter_lints: dependency: "direct dev" description: diff --git a/packages/example/pubspec.yaml b/packages/example/pubspec.yaml index 7afba88..096d393 100644 --- a/packages/example/pubspec.yaml +++ b/packages/example/pubspec.yaml @@ -35,6 +35,8 @@ dependencies: cupertino_icons: ^1.0.2 fl_query: path: ../fl_query + fl_query_hooks: + path: ../fl_query_hooks http: ^0.13.4 flutter_hooks: ^0.18.5 diff --git a/packages/fl_query/.flutter-plugins-dependencies b/packages/fl_query/.flutter-plugins-dependencies index 9c9f0eb..2271851 100644 --- a/packages/fl_query/.flutter-plugins-dependencies +++ b/packages/fl_query/.flutter-plugins-dependencies @@ -1 +1 @@ -{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"connectivity_plus","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus-2.3.5/","native_build":true,"dependencies":[]}],"android":[{"name":"connectivity_plus","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus-2.3.5/","native_build":true,"dependencies":[]}],"macos":[{"name":"connectivity_plus_macos","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_macos-1.2.4/","native_build":true,"dependencies":[]}],"linux":[{"name":"connectivity_plus_linux","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_linux-1.3.1/","native_build":false,"dependencies":[]}],"windows":[{"name":"connectivity_plus_windows","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_windows-1.2.2/","native_build":true,"dependencies":[]}],"web":[{"name":"connectivity_plus_web","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_web-1.2.2/","dependencies":[]}]},"dependencyGraph":[{"name":"connectivity_plus","dependencies":["connectivity_plus_linux","connectivity_plus_macos","connectivity_plus_web","connectivity_plus_windows"]},{"name":"connectivity_plus_linux","dependencies":[]},{"name":"connectivity_plus_macos","dependencies":[]},{"name":"connectivity_plus_web","dependencies":[]},{"name":"connectivity_plus_windows","dependencies":[]}],"date_created":"2022-07-07 10:27:09.479183","version":"3.0.1"} \ No newline at end of file +{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"connectivity_plus","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus-2.3.5/","native_build":true,"dependencies":[]}],"android":[{"name":"connectivity_plus","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus-2.3.5/","native_build":true,"dependencies":[]}],"macos":[{"name":"connectivity_plus_macos","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_macos-1.2.4/","native_build":true,"dependencies":[]}],"linux":[{"name":"connectivity_plus_linux","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_linux-1.3.1/","native_build":false,"dependencies":[]}],"windows":[{"name":"connectivity_plus_windows","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_windows-1.2.2/","native_build":true,"dependencies":[]}],"web":[{"name":"connectivity_plus_web","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_web-1.2.2/","dependencies":[]}]},"dependencyGraph":[{"name":"connectivity_plus","dependencies":["connectivity_plus_linux","connectivity_plus_macos","connectivity_plus_web","connectivity_plus_windows"]},{"name":"connectivity_plus_linux","dependencies":[]},{"name":"connectivity_plus_macos","dependencies":[]},{"name":"connectivity_plus_web","dependencies":[]},{"name":"connectivity_plus_windows","dependencies":[]}],"date_created":"2022-07-08 03:37:22.314541","version":"3.0.1"} \ No newline at end of file diff --git a/packages/fl_query/CHANGELOG.md b/packages/fl_query/CHANGELOG.md new file mode 100644 index 0000000..c7e00d8 --- /dev/null +++ b/packages/fl_query/CHANGELOG.md @@ -0,0 +1,11 @@ +v0.1.0 + +Initial Release + +- `QueryBowl` & `QueryBowlScope` for managing & caching all the query data. +- `Query` for advanced fetch, refetch & data management APIs +- `Mutation` for advanced mutate (a function that modifies data somewhere) & post-mutation management APIs +- `QueryJob` for defining the logic of how data should be fetched or refetched or invalidated +- `MutationJob` for defining the logic of how data should be mutated +- `QueryBuilder` for binding the `Query` & `QueryJob` to a Flutter Widget +- `MutationBuilder` for binding the `Mutation` & `MutationJob` to a Flutter Widget \ No newline at end of file diff --git a/packages/fl_query/LICENSE b/packages/fl_query/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/packages/fl_query/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/fl_query/lib/fl_query.dart b/packages/fl_query/lib/fl_query.dart index 5bf0401..da15442 100644 --- a/packages/fl_query/lib/fl_query.dart +++ b/packages/fl_query/lib/fl_query.dart @@ -7,3 +7,4 @@ export 'src/mutation.dart'; export 'src/mutation_builder.dart'; export 'src/models/query_job.dart'; export 'src/models/mutation_job.dart'; +export 'src/utils.dart' show isShallowEqual; diff --git a/packages/fl_query/lib/fl_query_hooks.dart b/packages/fl_query/lib/fl_query_hooks.dart deleted file mode 100644 index 6886efb..0000000 --- a/packages/fl_query/lib/fl_query_hooks.dart +++ /dev/null @@ -1,4 +0,0 @@ -library fl_query_hooks; - -export 'src/hooks/use_query.dart'; -export 'src/hooks/use_mutation.dart'; diff --git a/packages/fl_query/lib/src/query_bowl.dart b/packages/fl_query/lib/src/query_bowl.dart index c60e953..9598b06 100644 --- a/packages/fl_query/lib/src/query_bowl.dart +++ b/packages/fl_query/lib/src/query_bowl.dart @@ -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'; diff --git a/packages/fl_query/pubspec.yaml b/packages/fl_query/pubspec.yaml index 8dedfd0..3e15a47 100644 --- a/packages/fl_query/pubspec.yaml +++ b/packages/fl_query/pubspec.yaml @@ -1,5 +1,5 @@ name: fl_query -description: A new Flutter package project. +description: Asynchronous data caching, refetching & invalidation library for Flutter version: 0.1.0 homepage: https://fl-query.vercel.app diff --git a/packages/fl_query_hooks/.flutter-plugins b/packages/fl_query_hooks/.flutter-plugins new file mode 100644 index 0000000..a59874f --- /dev/null +++ b/packages/fl_query_hooks/.flutter-plugins @@ -0,0 +1,6 @@ +# This is a generated file; do not edit or check into version control. +connectivity_plus=/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus-2.3.5/ +connectivity_plus_linux=/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_linux-1.3.1/ +connectivity_plus_macos=/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_macos-1.2.4/ +connectivity_plus_web=/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_web-1.2.2/ +connectivity_plus_windows=/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_windows-1.2.2/ diff --git a/packages/fl_query_hooks/.flutter-plugins-dependencies b/packages/fl_query_hooks/.flutter-plugins-dependencies new file mode 100644 index 0000000..2e90a21 --- /dev/null +++ b/packages/fl_query_hooks/.flutter-plugins-dependencies @@ -0,0 +1 @@ +{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"connectivity_plus","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus-2.3.5/","native_build":true,"dependencies":[]}],"android":[{"name":"connectivity_plus","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus-2.3.5/","native_build":true,"dependencies":[]}],"macos":[{"name":"connectivity_plus_macos","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_macos-1.2.4/","native_build":true,"dependencies":[]}],"linux":[{"name":"connectivity_plus_linux","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_linux-1.3.1/","native_build":false,"dependencies":[]}],"windows":[{"name":"connectivity_plus_windows","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_windows-1.2.2/","native_build":true,"dependencies":[]}],"web":[{"name":"connectivity_plus_web","path":"/home/krtirtho/.pub-cache/hosted/pub.dartlang.org/connectivity_plus_web-1.2.2/","dependencies":[]}]},"dependencyGraph":[{"name":"connectivity_plus","dependencies":["connectivity_plus_linux","connectivity_plus_macos","connectivity_plus_web","connectivity_plus_windows"]},{"name":"connectivity_plus_linux","dependencies":[]},{"name":"connectivity_plus_macos","dependencies":[]},{"name":"connectivity_plus_web","dependencies":[]},{"name":"connectivity_plus_windows","dependencies":[]}],"date_created":"2022-07-08 03:38:23.823131","version":"3.0.1"} \ No newline at end of file diff --git a/packages/fl_query_hooks/.gitignore b/packages/fl_query_hooks/.gitignore new file mode 100644 index 0000000..96486fd --- /dev/null +++ b/packages/fl_query_hooks/.gitignore @@ -0,0 +1,30 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ +migrate_working_dir/ + +# IntelliJ related +*.iml +*.ipr +*.iws +.idea/ + +# The .vscode folder contains launch configuration and tasks you configure in +# VS Code which you may wish to be included in version control, so this line +# is commented out by default. +#.vscode/ + +# Flutter/Dart/Pub related +# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock. +/pubspec.lock +**/doc/api/ +.dart_tool/ +.packages +build/ diff --git a/packages/fl_query_hooks/.metadata b/packages/fl_query_hooks/.metadata new file mode 100644 index 0000000..756df28 --- /dev/null +++ b/packages/fl_query_hooks/.metadata @@ -0,0 +1,10 @@ +# This file tracks properties of this Flutter project. +# Used by Flutter tool to assess capabilities and perform upgrades etc. +# +# This file should be version controlled and should not be manually edited. + +version: + revision: fb57da5f945d02ef4f98dfd9409a72b7cce74268 + channel: stable + +project_type: package diff --git a/packages/fl_query_hooks/CHANGELOG.md b/packages/fl_query_hooks/CHANGELOG.md new file mode 100644 index 0000000..cc69b7d --- /dev/null +++ b/packages/fl_query_hooks/CHANGELOG.md @@ -0,0 +1,8 @@ +## 0.1.0 + +Initial Release + +- `useQuery` for binding the `Query` & `QueryJob` data to the UI layer of the application +- `useMutation` for binding the `Mutation` & `MutationJob` operations to the UI layer of the application + + diff --git a/packages/fl_query_hooks/LICENSE b/packages/fl_query_hooks/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/packages/fl_query_hooks/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/fl_query_hooks/README.md b/packages/fl_query_hooks/README.md new file mode 100644 index 0000000..3f8da19 --- /dev/null +++ b/packages/fl_query_hooks/README.md @@ -0,0 +1,3 @@ +# Fl-Query Hooks + +The `flutter_hooks` compatible version of Fl-Query \ No newline at end of file diff --git a/packages/fl_query_hooks/lib/fl_query_hooks.dart b/packages/fl_query_hooks/lib/fl_query_hooks.dart new file mode 100644 index 0000000..e7dec27 --- /dev/null +++ b/packages/fl_query_hooks/lib/fl_query_hooks.dart @@ -0,0 +1,4 @@ +library fl_query_hooks; + +export 'src/use_query.dart'; +export 'src/use_mutation.dart'; diff --git a/packages/fl_query/lib/src/hooks/use_mutation.dart b/packages/fl_query_hooks/lib/src/use_mutation.dart similarity index 93% rename from packages/fl_query/lib/src/hooks/use_mutation.dart rename to packages/fl_query_hooks/lib/src/use_mutation.dart index 03e11ea..ded48e2 100644 --- a/packages/fl_query/lib/src/hooks/use_mutation.dart +++ b/packages/fl_query_hooks/lib/src/use_mutation.dart @@ -1,7 +1,5 @@ -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:fl_query/fl_query.dart'; +import 'package:fl_query_hooks/src/utils.dart'; import 'package:flutter/widgets.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; diff --git a/packages/fl_query/lib/src/hooks/use_query.dart b/packages/fl_query_hooks/lib/src/use_query.dart similarity index 94% rename from packages/fl_query/lib/src/hooks/use_query.dart rename to packages/fl_query_hooks/lib/src/use_query.dart index 0687bf5..25a44eb 100644 --- a/packages/fl_query/lib/src/hooks/use_query.dart +++ b/packages/fl_query_hooks/lib/src/use_query.dart @@ -1,7 +1,5 @@ -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:fl_query/fl_query.dart'; +import 'package:fl_query_hooks/src/utils.dart'; import 'package:flutter/widgets.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; diff --git a/packages/fl_query_hooks/lib/src/utils.dart b/packages/fl_query_hooks/lib/src/utils.dart new file mode 100644 index 0000000..941986f --- /dev/null +++ b/packages/fl_query_hooks/lib/src/utils.dart @@ -0,0 +1,3 @@ +import 'package:uuid/uuid.dart'; + +const uuid = Uuid(); diff --git a/packages/fl_query_hooks/pubspec.yaml b/packages/fl_query_hooks/pubspec.yaml new file mode 100644 index 0000000..f8c7538 --- /dev/null +++ b/packages/fl_query_hooks/pubspec.yaml @@ -0,0 +1,25 @@ +name: fl_query_hooks +description: Elite flutter_hooks compatible library for fl_query, the Asynchronous data caching, refetching & invalidation library for Flutter +version: 0.1.0 +homepage: https://fl-query.vercel.app + +issue_tracker: https://github.com/KRTirtho/fl-query/issues + +repository: https://github.com/KRTirtho/fl-query + +environment: + sdk: ">=2.17.1 <3.0.0" + flutter: ">=1.17.0" + +dependencies: + flutter: + sdk: flutter + flutter_hooks: ^0.18.5+1 + uuid: ^3.0.6 + fl_query: + path: ../fl_query + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^2.0.0 diff --git a/packages/fl_query_hooks/test/fl_query_hooks_test.dart b/packages/fl_query_hooks/test/fl_query_hooks_test.dart new file mode 100644 index 0000000..0da434d --- /dev/null +++ b/packages/fl_query_hooks/test/fl_query_hooks_test.dart @@ -0,0 +1,5 @@ +import 'package:flutter_test/flutter_test.dart'; + +void main() { + test('adds one to input values', () {}); +}