Better exports

README.md

@@ -28,7 +28,6 @@ Node:
 ## Usage
 
 ```typescript
-
 import {
   KentekenVoertuigen,
   KentekenVoertuigenAssen,
@@ -41,18 +40,11 @@ import {
 } from "https://deno.land/x/rdw_data/mod.ts";
 
 /*
-  * Example: search for a license plate and combine the results
-  */
+ * Example: search for a license plate and combine the results
+ */
 const search = (
   kenteken: string,
-): Promise<
-  & KentekenVoertuigen.ResponseData
-  & KentekenVoertuigenAssen.ResponseData
-  & KentekenVoertuigenBrandstof.ResponseData
-  & KentekenVoertuigenCarrosserie.ResponseData
-  & KentekenVoertuigenCarrosserieSpecificatie.ResponseData
-  & KentekenVoertuigenVoertuigklasse.ResponseData
-> =>
+) =>
   Promise.all([
     KentekenVoertuigen.RDWQuery().where(
       Where.like(KentekenVoertuigen.Fields.Kenteken, kenteken),
@@ -91,16 +83,13 @@ const combined = await search("XXXXX");
 
 console.log(data.count);
 console.log(combined);
-
 ```
 
 <!-- START FUNCTIONS -->
 ## API
 
 These are auto generated providers and use `[email protected]`.
 
-An overview can be found [here](https://deno.land/x/rdw_data/src/providers/mod.ts)
-
 ### Overview
 
 | Provider | Name | Category |

deno.json

@@ -1,30 +1,30 @@
 {
-    "tasks": {
-        "fetch": "deno run -A scripts/fetch-databases.ts",
-        "format": "deno fmt",
-        "lint": "deno lint ./src/",
-        "fetch-data": "deno run -A scripts/fetch-databases.ts && deno fmt -q ./src/providers && deno lint",
-        "npm": "deno run -A ./scripts/build-npm.ts"
+  "tasks": {
+    "fetch": "deno run -A scripts/fetch-databases.ts",
+    "format": "deno fmt",
+    "lint": "deno lint ./src/",
+    "fetch-data": "deno run -A scripts/fetch-databases.ts && deno fmt -q ./src/providers && deno lint",
+    "npm": "deno run -A ./scripts/build-npm.ts"
+  },
+  "fmt": {
+    "options": {
+      "indentWidth": 2,
+      "lineWidth": 100,
+      "singleQuote": false,
+      "useTabs": false,
+      "proseWrap": "preserve"
     },
-    "fmt": {
-        "options": {
-            "indentWidth": 2,
-            "lineWidth": 100,
-            "singleQuote": false,
-            "useTabs": false,
-            "proseWrap": "preserve"
-        },
-        "exclude": []
+    "exclude": []
+  },
+  "lint": {
+    "rules": {
+      "include": [
+        "ban-untagged-todo",
+        "explicit-function-return-type"
+      ]
     },
-    "lint": {
-        "rules": {
-            "include": [
-                "ban-untagged-todo",
-                "explicit-function-return-type"
-            ]
-        },
-        "exclude": [
-            "npm/"
-        ]
-    }
+    "exclude": [
+      "npm/"
+    ]
+  }
 }

scripts/templates/mod.ts.ejs

@@ -13,4 +13,5 @@ export {
   Where,
 } from "https://deno.land/x/soda@<%= it.sodaVersion %>/mod.ts";
 <% it.items.forEach(function (item) { %>
-export * as <%= item.name %> from "./<%= item.name %>.ts";<% }); %>
+export { <%= item.name %> } from "./<%= item.name %>.ts";
+export type { <%= item.name %>_ResponseData } from "./<%= item.name %>.ts";<% }); %>

scripts/templates/provider.ts.ejs

@@ -15,13 +15,13 @@
 //
 // *******************************************************
 
-import type { AuthOpts, FieldObject, Options } from "https://deno.land/x/soda@<%= it.item.sodaVersion %>/mod.ts";
+import type { AuthOpts, Options } from "https://deno.land/x/soda@<%= it.item.sodaVersion %>/mod.ts";
 import { createQueryWithDataset, DataType, Field } from "https://deno.land/x/soda@<%= it.item.sodaVersion %>/mod.ts";
 
 /**
  * Return Data for <%= it.item.full_name %>
  */
-export interface ResponseData {<% it.item.columns.forEach(function(column) { %>
+export interface <%= it.item.name %>_ResponseData {<% it.item.columns.forEach(function(column) { %>
   /**
    * ### <%= column.name %>
    *
@@ -43,19 +43,17 @@ export interface ResponseData {<% it.item.columns.forEach(function(column) { %>
  *
  * > You can use these fieldnames in your queries to filter, group, or sort your data.
  */
-export interface IFields {<% it.item.columns.forEach(function(column) { %>
+export const Fields = {<% it.item.columns.forEach(function(column) { %>
   /**
-   * ### <%= column.name %>
-   *
-   * <% column.description.forEach(function(line) { %>
-   * <%= line %><% }); %>
-   *
-   * **Type**: <%= column.datatype %>
-   */
-   <%= column.big_name %>: FieldObject<<%= column.datatypeTemplate %>>;<% }); %>
-};
-
-export const Fields: IFields = {<% it.item.columns.forEach(function(column) { %>
+  * ### <%= column.name %>
+  *
+  * <% column.description.forEach(function(line) { %>
+  * <%= line %><% }); %>
+  *
+  * **Type**: <%= column.datatype %>
+  *
+  * **Database Column Name**: `<%= column.field_name %>`
+  */
   <%= column.big_name %>: Field("<%= column.field_name %>", <%= column.datatypeTemplate %>),<% }); %>
 };
 
@@ -82,9 +80,30 @@ export const Info = {
  * **Dataset ID:** <%= it.item.id %>
  *
  * **Category:** <%= it.item.category %>
+ *
+ * -----------------------
+ * This generates a SodaQuery for the <%= it.item.full_name %> dataset.
+ *
+ * @param auth - Authentification options
+ * @param opts - Query options
+ *
+ * @example
+ * ```ts
+ * const data = await RDWQuery()
+ *   .where(Where.like(Fields.<%= it.item.columns[0].big_name %>, "some_value")
+ *   .limit(10)
+ *   .offset(0);
+ *   .execute();
+ * ```
  */
 export const RDWQuery = (auth: AuthOpts = {}, opts: Options = {}) =>
-  createQueryWithDataset<ResponseData>(Info.domain, Info.dataset, auth, {
+  createQueryWithDataset<<%= it.item.name %>_ResponseData>(Info.domain, Info.dataset, auth, {
     ...opts,
     strict: typeof opts.strict === "boolean" ? opts.strict : true,
   });
+
+export const <%= it.item.name %> = {
+  RDWQuery,
+  Fields: Fields,
+  Info: Info,
+};