Refactor module exports and improve type usage

Mqxx · Mqxx · commit fc0af2094352 · 2025-10-10T13:11:56.000+02:00
Refactored module exports to use named exports and index files for better structure and tree-shaking. Replaced default exports with named exports, consolidated DNS record types, and updated imports to use type-only imports where appropriate. Improved error handling imports, reorganized response and record modules, and renamed files for clarity. These changes enhance maintainability, type safety, and code clarity.
diff --git a/deno.json b/deno.json
@@ -17,7 +17,6 @@
     ]
   },
   "compilerOptions": {
-    "experimentalDecorators": true,
     "lib": [
       "ES6",
       "DOM",
@@ -42,7 +41,8 @@
         "guard-for-in",
         "no-eval",
         "no-sparse-arrays",
-        "prefer-ascii"
+        "prefer-ascii",
+        "verbatim-module-syntax"
       ],
       "exclude": [
         "no-inferrable-types"
diff --git a/src/api/create_dns_record.ts b/src/api/create_dns_record.ts
@@ -1,9 +1,14 @@
-import ApiRequestError from '../error/api_request_error.ts';
-import FetchRequestError from '../error/fetch_request_error.ts';
-import { DnsRecord } from '../record/dns_record.ts';
-import { ApiRequestOptions } from './api_request_options.ts';
+import * as error from '../error/index.ts';
+import type { DnsRecord } from '../record/dns_record.ts';
+import type { ApiRequestOptions } from './api_request_options.ts';
 
-export default function createDnsRecord(
+
+/**
+ * This function creates a DNS record.
+ * 
+ * @param options Options for the API fetch
+ */
+export function createDnsRecord(
   record : DnsRecord,
   options : ApiRequestOptions
 ) : void {
@@ -26,11 +31,11 @@ export default function createDnsRecord(
       if (response.ok) {
         return response.json();
       }
-      throw new FetchRequestError({cause: response.statusText});
+      throw new error.FetchRequestError({cause: response.statusText});
     })
     .then((responseJson) => {
       if (!responseJson.success) {
-        throw new ApiRequestError({cause: responseJson.errors})
+        throw new error.ApiRequestError({cause: responseJson.errors})
       }
     });
 }
diff --git a/src/api/index.ts b/src/api/index.ts
@@ -1,17 +1,5 @@
-import createDnsRecord from './create_dns_record.ts';
-import listDnsRecords from './list_dns_records.ts'
-import updateDnsRecord from './update_dns_record.ts'
-
-const api = {
-  createDnsRecord,
-  listDnsRecords,
-  updateDnsRecord
-}
-
-export {
-  createDnsRecord,
-  listDnsRecords,
-  updateDnsRecord
-}
-
-export default api;
+export { createDnsRecord } from './create_dns_record.ts'
+export { listDnsRecords } from './list_dns_records.ts'
+export { updateDnsRecord } from './update_dns_record.ts'
+export type { ApiRequestOptions } from './api_request_options.ts'
+export type * as response from './response/index.ts'
diff --git a/src/api/list_dns_records.ts b/src/api/list_dns_records.ts
@@ -1,18 +1,17 @@
-import ApiRequestError from '../error/api_request_error.ts';
-import FetchRequestError from '../error/fetch_request_error.ts';
-import { DnsRecordList } from '../record/dns_record_list.ts';
-import supportedDnsRecordTypes from '../record/dns_record_type.ts';
-import { ApiRequestOptions } from './api_request_options.ts';
+import * as error from '../error/index.ts';
+import type { DnsRecordList } from '../record/dns_record_list.ts';
+import * as record from '../record/index.ts';
+import type { ApiRequestOptions } from './api_request_options.ts';
 
 /**
  * This function gets all DNS records, filtered by the DNS record types.
  * 
  * @param options Options for the API fetch
  * @returns List of all DNS records found.
  */
-export default function listDnsRecordsFromApi(options : ApiRequestOptions) : Promise<DnsRecordList[]> {
+export function listDnsRecords(options : ApiRequestOptions) : Promise<DnsRecordList[]> {
   return fetch(
-    `${options.apiEndpoint}zones/${options.zoneId}/dns_records?type=${supportedDnsRecordTypes.join(',')}`,
+    `${options.apiEndpoint}zones/${options.zoneId}/dns_records?type=${record.dnsRecordTypes.join(',')}`,
     {
       method: 'GET',
       headers: {
@@ -25,12 +24,12 @@ export default function listDnsRecordsFromApi(options : ApiRequestOptions) : Pro
       if (response.ok) {
         return response.json();
       }
-      throw new FetchRequestError({cause: response.statusText});
+      throw new error.FetchRequestError({cause: response.statusText});
     })
     .then((responseJson) => {
       if (responseJson.success) {
         return responseJson.result
       }
-      throw new ApiRequestError({cause: responseJson.errors})
+      throw new error.ApiRequestError({cause: responseJson.errors})
     });
 }
diff --git a/src/api/response/dns_records/create_dns_record_response.ts b/src/api/response/dns_records/create_dns_record_response.ts
@@ -2,18 +2,17 @@
 import type { Errors } from '../errors.ts';
 import type { Messages } from '../messages.ts';
 import type { ResultInfo } from '../result_info.ts';
-import type { ARecord } from './records/a_record.ts';
-import type { AAAARecord } from './records/aaaa_record.ts';
-import type { CNAMERecord } from './records/cname_record.ts';
+import type * as records from './records/index.ts'
+
 
 /**
  * This interface represents the response of a DNS record that got created.
  */
 export interface CreateNdsRecordResponse {
   result : (
-    | ARecord
-    | AAAARecord
-    | CNAMERecord
+    | records.ARecord
+    | records.AAAARecord
+    | records.CNAMERecord
   )[],
   errors : Errors[],
   messages : Messages[],
diff --git a/src/api/response/dns_records/index.ts b/src/api/response/dns_records/index.ts
@@ -0,0 +1,3 @@
+export type { CreateNdsRecordResponse } from './create_dns_record_response.ts'
+export type { ListDnsRecordsResponse } from './list_dns_records_response.ts'
+export type * as records from './records/index.ts'
diff --git a/src/api/response/dns_records/list_dns_records_response.ts b/src/api/response/dns_records/list_dns_records_response.ts
@@ -2,18 +2,17 @@
 import type { Errors } from '../errors.ts';
 import type { Messages } from '../messages.ts';
 import type { ResultInfo } from '../result_info.ts';
-import type { ARecord } from './records/a_record.ts';
-import type { AAAARecord } from './records/aaaa_record.ts';
-import type { CNAMERecord } from './records/cname_record.ts';
+import type * as records from './records/index.ts'
+
 
 /**
  * This interface represents the response of a DNS record list.
  */
 export interface ListDnsRecordsResponse {
   result : (
-    | ARecord
-    | AAAARecord
-    | CNAMERecord
+    | records.ARecord
+    | records.AAAARecord
+    | records.CNAMERecord
   )[],
   errors : Errors[],
   messages : Messages[],
diff --git a/src/api/response/dns_records/records/index.ts b/src/api/response/dns_records/records/index.ts
@@ -0,0 +1,3 @@
+export type { ARecord } from './a_record.ts'
+export type { AAAARecord } from './aaaa_record.ts'
+export type { CNAMERecord } from './cname_record.ts'
diff --git a/src/api/response/index.ts b/src/api/response/index.ts
@@ -0,0 +1,4 @@
+export type { Errors } from './errors.ts'
+export type { Messages } from './messages.ts'
+export type { ResultInfo } from './result_info.ts'
+export type * as dnsRecords from './dns_records/index.ts';
diff --git a/src/api/update_dns_record.ts b/src/api/update_dns_record.ts
@@ -1,9 +1,8 @@
-import ApiRequestError from '../error/api_request_error.ts';
-import FetchRequestError from '../error/fetch_request_error.ts';
-import { DnsRecord } from '../record/dns_record.ts';
-import { ApiRequestOptions } from './api_request_options.ts';
+import * as error from '../error/index.ts';
+import type { DnsRecord } from '../record/dns_record.ts';
+import type { ApiRequestOptions } from './api_request_options.ts';
 
-export default function updateDnsRecord(
+export function updateDnsRecord(
   recordId : string,
   record : DnsRecord,
   options : ApiRequestOptions
@@ -23,11 +22,11 @@ export default function updateDnsRecord(
       if (response.ok) {
         return response.json();
       }
-      throw new FetchRequestError({cause: response.statusText});
+      throw new error.FetchRequestError({cause: response.statusText});
     })
     .then((responseJson) => {
       if (!responseJson.success) {
-        throw new ApiRequestError({cause: responseJson.errors})
+        throw new error.ApiRequestError({cause: responseJson.errors})
       }
     });
 }
diff --git a/src/error/api_request_error.ts b/src/error/api_request_error.ts
@@ -1,9 +1,9 @@
-import CustomError from './custom_error.ts'
+import { CustomError } from './custom_error.ts'
 
 /**
  * This class represents an api request error. This error is thrown if there is an error during the api request.
  */
-export default class ApiRequestError extends CustomError {
+export class ApiRequestError extends CustomError {
   /**
    * @param error The custom error options
    */
diff --git a/src/error/custom_error.ts b/src/error/custom_error.ts
@@ -6,7 +6,7 @@
  * 
  * @returns The custom error
  */
-export default class CustomError extends Error {
+export class CustomError extends Error {
   /**
    * @param message The custom error message
    * @param options The custom error options
diff --git a/src/error/fetch_request_error.ts b/src/error/fetch_request_error.ts
@@ -1,9 +1,9 @@
-import CustomError from './custom_error.ts'
+import { CustomError } from './custom_error.ts'
 
 /**
  * This class represents an fetch request error. This error is thrown if there is an error during the fetch request.
  */
-export default class FetchRequestError extends CustomError {
+export class FetchRequestError extends CustomError {
   /**
    * @param error The custom error options
    */
diff --git a/src/error/index.ts b/src/error/index.ts
@@ -0,0 +1,2 @@
+export { ApiRequestError } from './api_request_error.ts'
+export { FetchRequestError } from './fetch_request_error.ts'
diff --git a/src/record/dns_record.ts b/src/record/dns_record.ts
@@ -1,4 +1,4 @@
-import { DnsRecordType } from './dns_record_type.ts';
+import type { DnsRecordType } from './dns_record_types.ts';
 
 /**
  * This interface represents a record.
diff --git a/src/record/dns_record_list.ts b/src/record/dns_record_list.ts
@@ -1,4 +1,4 @@
-import { DnsRecord } from './dns_record.ts';
+import type { DnsRecord } from './dns_record.ts';
 
 export interface DnsRecordList extends DnsRecord {
   
diff --git a/src/record/dns_record_type.ts b/src/record/dns_record_type.ts
diff --git a/src/record/dns_record_types.ts b/src/record/dns_record_types.ts
@@ -0,0 +1,12 @@
+import type { ValuesFromArray } from '../type/values_from_array.ts';
+
+export const dnsRecordTypes = [
+  'A',
+  'AAAA',
+  'CNAME'
+]
+
+/**
+ * This type represents all allowed records to use.
+ */
+export type DnsRecordType = ValuesFromArray<typeof dnsRecordTypes>;
diff --git a/src/record/index.ts b/src/record/index.ts
@@ -0,0 +1,3 @@
+export type { DnsRecord } from './dns_record.ts'
+export type { DnsRecordList } from './dns_record_list.ts'
+export { type DnsRecordType, dnsRecordTypes } from './dns_record_types.ts'
diff --git a/src/request_url/error/index.ts b/src/request_url/error/index.ts
@@ -0,0 +1,3 @@
+export { MissingURLParameterKeyError } from './missing_url_parameter_key_error.ts';
+export { MissingURLParameterValueError } from './missing_url_parameter_value_error.ts';
+
diff --git a/src/request_url/error/missing_url_parameter_key_error.ts b/src/request_url/error/missing_url_parameter_key_error.ts
@@ -3,7 +3,7 @@ import CustomError from '../../error/custom_error.ts'
 /**
  * This class represents a missing URL parameters error. This error is thrown if there is a missing URL parameter.
  */
-export default class MissingURLParameterKeyError extends CustomError {
+export class MissingURLParameterKeyError extends CustomError {
   parameter : string;
   /**
    * @param parameter The missing parameter
diff --git a/src/request_url/error/missing_url_parameter_value_error.ts b/src/request_url/error/missing_url_parameter_value_error.ts
@@ -3,7 +3,7 @@ import CustomError from '../../error/custom_error.ts'
 /**
  * This class represents a missing URL parameters error. This error is thrown if there is a missing URL parameter.
  */
-export default class MissingURLParameterValueError extends CustomError {
+export class MissingURLParameterValueError extends CustomError {
   parameter : string;
   /**
    * @param parameter The missing parameter
diff --git a/src/request_url/index.ts b/src/request_url/index.ts
@@ -1,9 +1,3 @@
-import parse from './parameter/parse.ts';
-
-const requestUrl = {
-  parse
-};
-
-export { parse }
-
-export default requestUrl;
+export * as error from './error/index.ts';
+export * as parameter from './parameter/index.ts';
+export { parse } from './parse.ts'
diff --git a/src/request_url/parameter/get_from_url.ts b/src/request_url/parameter/get_from_url.ts
@@ -1,25 +1,25 @@
-import MissingURLParameterKeyError from '../error/missing_url_parameter_key_error.ts';
-import MissingURLParameterValueError from '../error/missing_url_parameter_value_error.ts';
+import * as error from '../error/index.ts';
 
 /**
  * This function extracts a list of values from the URL parameters.
+ * 
  * @param urlSearch The search string of the URL
  * @param key The key of the parameter to extract
  * @returns An array of values associated with the given key.
  */
-export default function getFromUrl(
+export function getFromUrl(
   urlSearch : string,
   key : string
 ) : string[] {
   const urlParams = new URLSearchParams(urlSearch);
 
   if (!urlParams.has(key)) {
-    throw new MissingURLParameterKeyError(key);
+    throw new error.MissingURLParameterKeyError(key);
   }
 
   const value = urlParams.getAll(key);
   if (value.length === 0) {
-    throw new MissingURLParameterValueError(key);
+    throw new error.MissingURLParameterValueError(key);
   }
 
   return value;
diff --git a/src/request_url/parameter/index.ts b/src/request_url/parameter/index.ts
@@ -0,0 +1,2 @@
+export { getFromUrl } from './get_from_url.ts'
+export type { UrlObject } from './url_object.ts'
diff --git a/src/request_url/parameter/url_object.ts b/src/request_url/parameter/url_object.ts
@@ -1,4 +1,5 @@
-import { DnsRecord } from '../../record/dns_record.ts';
+import type { DnsRecord } from '../../record/dns_record.ts';
+
 
 /**
  * This interface represents the URL parameters from the request.
diff --git a/src/request_url/parse.ts b/src/request_url/parse.ts
@@ -1,13 +1,15 @@
-import { DnsRecord } from '../../record/dns_record.ts';
-import getFromUrl from './get_from_url.ts';
-import { UrlObject } from './url_object.ts';
+import type {DnsRecord} from '../record/dns_record.ts';
+import {getFromUrl} from './parameter/get_from_url.ts';
+import type {UrlObject} from './parameter/url_object.ts';
+
 
 /**
  * This function parses the URL parameters and returns an object containing the parsed data.
+ * 
  * @param url The URL to parse
  * @returns An object containing the parsed data.
  */
-export default function parse(url : string) : UrlObject {
+export function parse(url : string) : UrlObject {
   const urlSearch = new URL(url).search;
 
   const token = getFromUrl(urlSearch, 'token')[0];
diff --git a/src/worker.ts b/src/worker.ts

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export type { CreateNdsRecordResponse } from './create_dns_record_response.ts'`
	`2`	`+export type { ListDnsRecordsResponse } from './list_dns_records_response.ts'`
	`3`	`+export type * as records from './records/index.ts'`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export type { ARecord } from './a_record.ts'`
	`2`	`+export type { AAAARecord } from './aaaa_record.ts'`
	`3`	`+export type { CNAMERecord } from './cname_record.ts'`