Merge branch 'main' of github.com:imp-dance/rtk-query-loader

Author: imp-dance

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Actual behavior**
+A clear and concise description of what actually happened.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Device (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+ 
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

README.md

@@ -21,8 +21,8 @@ A simple example of a component using rtk-query-loader:
 
 ```tsx
 import {
-  createUseLoader,
-  RTKLoader,
+  createLoader,
+  withLoader,
 } from "@ryfylke-react/rtk-query-loader";
 
 const loader = createLoader({
@@ -224,19 +224,35 @@ const pokemonLoader = baseLoader.extend({
 
 New properties will overwrite existing.
 
-> If the loader you extend has a `transform` function, and you are changing the `queries` function, you might need to do this to resolve the types properly:
+**NOTE**:
+
+> If the loader that you _extend from_ has a `transform` function, and you are change the `queries` function in the _extended_ loader, you might need to do the following fix to resolve the types correctly:
 
 ```typescript
 const baseLoader = createLoader({
   queries: () => [...],
   transform: () => {i_want: "this-format"},
 })
 
-const pokemonLoader = baseLoader.extend({
+// This first example is extending a loader that has a transform.
+// It does not supply a new transform function
+const extendedOne = baseLoader.extend(({
+   queries: () => [...],
+}))
+
+type TestOne = InferLoaderData<typeof extendedOne>;
+// Resolves to: { i_want: string; }
+// which is incorrect. In reality it defaults to your list of queries.
+
+// In this example, we supply a transform function as well:
+const extendedTwo = baseLoader.extend({
   queries: () => [...],
-  transform: (q) => q, // Reapply default transform for query
+  transform: (q) => q, // This is essentially the default value
 });
 
-type Test = ReturnType<typeof pokemonLoader.useLoader>;
-// { i_want: string; }
+type TestTwo = InferLoaderData<typeof extendedTwo>;
+// Resolves to: readonly [UseQueryResult<...>]
+// which is correct.
 ```
+
+> This is just a type mistake that will hopefully be fixed in the future. Both `extendedOne` and `extendedTwo` return the same format, but `extendedTwo` has the correct types.