Breaking change (fixing #12) with code cleaning

.eslintrc

@@ -29,7 +29,7 @@
         "prefer-regex-literals": "warn",
         "no-control-regex": "warn",
         "no-use-before-define": "warn",
-        "no-param-reassign": "warn",
+        "no-param-reassign": "off",
         "max-classes-per-file": "warn",
         "no-useless-constructor": "off"
     },

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maestro-org/typescript-sdk",
-  "version": "1.4.2",
+  "version": "2.0.0",
   "description": "TypeScript SDK for the Maestro Dapp Platform",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

src/api/blocks/helpers.ts

@@ -15,54 +15,52 @@ import { TimestampedBlockInfo } from '../type';
  * BlocksApi - axios parameter creator
  * @export
  */
-export const BlocksApiAxiosParamCreator = function (configuration: Configuration) {
-    return {
-        /**
-         * Returns information about the specified block including more advanced technical properties
-         * @summary Block information
-         * @param {string} hashOrHeight Block height or hex encoded block hash
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        blockInfo: async (hashOrHeight: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'hashOrHeight' is not null or undefined
-            assertParamExists('blockInfo', 'hashOrHeight', hashOrHeight);
-            const localVarPath = `/blocks/{hash_or_height}`.replace(
-                `{${'hash_or_height'}}`,
-                encodeURIComponent(String(hashOrHeight)),
-            );
-            // use dummy base URL string because the URL constructor only accepts absolute URLs.
-            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
-            const { baseOptions } = configuration;
+export const BlocksApiAxiosParamCreator = (configuration: Configuration) => ({
+    /**
+     * Returns information about the specified block including more advanced technical properties
+     * @summary Block information
+     * @param {string} hashOrHeight Block height or hex encoded block hash
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    blockInfo: async (hashOrHeight: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        // verify required parameter 'hashOrHeight' is not null or undefined
+        assertParamExists('blockInfo', 'hashOrHeight', hashOrHeight);
+        const localVarPath = `/blocks/{hash_or_height}`.replace(
+            `{${'hash_or_height'}}`,
+            encodeURIComponent(String(hashOrHeight)),
+        );
+        // use dummy base URL string because the URL constructor only accepts absolute URLs.
+        const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+        const { baseOptions } = configuration;
 
-            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
-            const localVarHeaderParameter = {} as any;
-            const localVarQueryParameter = {} as any;
+        const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+        const localVarHeaderParameter = {} as Record<string, string>;
+        const localVarQueryParameter = {} as Record<string, string>;
 
-            // authentication api-key required
-            setApiKeyToObject(localVarHeaderParameter, 'api-key', configuration);
+        // authentication api-key required
+        setApiKeyToObject(localVarHeaderParameter, 'api-key', configuration);
 
-            setSearchParams(localVarUrlObj, localVarQueryParameter);
-            const headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = {
-                ...localVarHeaderParameter,
-                ...headersFromBaseOptions,
-                ...options.headers,
-            };
+        setSearchParams(localVarUrlObj, localVarQueryParameter);
+        const headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+        localVarRequestOptions.headers = {
+            ...localVarHeaderParameter,
+            ...headersFromBaseOptions,
+            ...options.headers,
+        };
 
-            return {
-                url: toPathString(localVarUrlObj),
-                options: localVarRequestOptions,
-            };
-        },
-    };
-};
+        return {
+            url: toPathString(localVarUrlObj),
+            options: localVarRequestOptions,
+        };
+    },
+});
 
 /**
  * BlocksApi - functional programming interface
  * @export
  */
-export const BlocksApiFp = function (configuration: Configuration) {
+export const BlocksApiFp = (configuration: Configuration) => {
     const localVarAxiosParamCreator = BlocksApiAxiosParamCreator(configuration);
     return {
         /**
@@ -81,23 +79,3 @@ export const BlocksApiFp = function (configuration: Configuration) {
         },
     };
 };
-
-// /**
-//  * BlocksApi - factory interface
-//  * @export
-//  */
-// export const BlocksApiFactory = function (configuration: Configuration, basePath?: string, axios?: AxiosInstance) {
-//     const localVarFp = BlocksApiFp(configuration);
-//     return {
-//         /**
-//          * Returns information about the specified block including more advanced technical properties
-//          * @summary Block information
-//          * @param {string} hashOrHeight Block height or hex encoded block hash
-//          * @param {*} [options] Override http request option.
-//          * @throws {RequiredError}
-//          */
-//         blockInfo(hashOrHeight: string, options?: any): AxiosPromise<TimestampedBlockInfo> {
-//             return localVarFp.blockInfo(hashOrHeight, options).then((request) => request(axios, basePath));
-//         },
-//     };
-// };

src/api/datum/helpers.ts

@@ -16,92 +16,87 @@ import { TimestampedDatum, TimestampedDatums } from '../type';
  * DatumApi - axios parameter creator
  * @export
  */
-export const DatumApiAxiosParamCreator = function (configuration: Configuration) {
-    return {
-        /**
-         * Returns the datum corresponding to the specified datum hash, if the datum has been seen on-chain
-         * @summary Datum by datum hash
-         * @param {string} datumHash Hex encoded datum hash
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        lookupDatum: async (datumHash: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'datumHash' is not null or undefined
-            assertParamExists('lookupDatum', 'datumHash', datumHash);
-            const localVarPath = `/datums/{datum_hash}`.replace(
-                `{${'datum_hash'}}`,
-                encodeURIComponent(String(datumHash)),
-            );
-            // use dummy base URL string because the URL constructor only accepts absolute URLs.
-            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
-            const { baseOptions } = configuration;
+export const DatumApiAxiosParamCreator = (configuration: Configuration) => ({
+    /**
+     * Returns the datum corresponding to the specified datum hash, if the datum has been seen on-chain
+     * @summary Datum by datum hash
+     * @param {string} datumHash Hex encoded datum hash
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lookupDatum: async (datumHash: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        // verify required parameter 'datumHash' is not null or undefined
+        assertParamExists('lookupDatum', 'datumHash', datumHash);
+        const localVarPath = `/datums/{datum_hash}`.replace(`{${'datum_hash'}}`, encodeURIComponent(String(datumHash)));
+        // use dummy base URL string because the URL constructor only accepts absolute URLs.
+        const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+        const { baseOptions } = configuration;
 
-            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
-            const localVarHeaderParameter = {} as any;
-            const localVarQueryParameter = {} as any;
+        const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+        const localVarHeaderParameter = {} as Record<string, string>;
+        const localVarQueryParameter = {} as Record<string, string>;
 
-            // authentication api-key required
-            setApiKeyToObject(localVarHeaderParameter, 'api-key', configuration);
+        // authentication api-key required
+        setApiKeyToObject(localVarHeaderParameter, 'api-key', configuration);
 
-            setSearchParams(localVarUrlObj, localVarQueryParameter);
-            const headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = {
-                ...localVarHeaderParameter,
-                ...headersFromBaseOptions,
-                ...options.headers,
-            };
+        setSearchParams(localVarUrlObj, localVarQueryParameter);
+        const headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+        localVarRequestOptions.headers = {
+            ...localVarHeaderParameter,
+            ...headersFromBaseOptions,
+            ...options.headers,
+        };
 
-            return {
-                url: toPathString(localVarUrlObj),
-                options: localVarRequestOptions,
-            };
-        },
-        /**
-         * Returns the datums corresponding to the specified datum hashes, for the datums which have been seen on-chain
-         * @summary Datums by datum hashes
-         * @param {Array<string>} requestBody Array of hex encoded datum hashes
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        lookupDatums: async (requestBody: Array<string>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'requestBody' is not null or undefined
-            assertParamExists('lookupDatums', 'requestBody', requestBody);
-            const localVarPath = `/datums`;
-            // use dummy base URL string because the URL constructor only accepts absolute URLs.
-            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
-            const { baseOptions } = configuration;
+        return {
+            url: toPathString(localVarUrlObj),
+            options: localVarRequestOptions,
+        };
+    },
+    /**
+     * Returns the datums corresponding to the specified datum hashes, for the datums which have been seen on-chain
+     * @summary Datums by datum hashes
+     * @param {Array<string>} requestBody Array of hex encoded datum hashes
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    lookupDatums: async (requestBody: Array<string>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        // verify required parameter 'requestBody' is not null or undefined
+        assertParamExists('lookupDatums', 'requestBody', requestBody);
+        const localVarPath = `/datums`;
+        // use dummy base URL string because the URL constructor only accepts absolute URLs.
+        const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+        const { baseOptions } = configuration;
 
-            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
-            const localVarHeaderParameter = {} as any;
-            const localVarQueryParameter = {} as any;
+        const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
+        const localVarHeaderParameter = {} as Record<string, string>;
+        const localVarQueryParameter = {} as Record<string, string>;
 
-            // authentication api-key required
-            setApiKeyToObject(localVarHeaderParameter, 'api-key', configuration);
+        // authentication api-key required
+        setApiKeyToObject(localVarHeaderParameter, 'api-key', configuration);
 
-            localVarHeaderParameter['Content-Type'] = 'application/json';
+        localVarHeaderParameter['Content-Type'] = 'application/json';
 
-            setSearchParams(localVarUrlObj, localVarQueryParameter);
-            const headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = {
-                ...localVarHeaderParameter,
-                ...headersFromBaseOptions,
-                ...options.headers,
-            };
-            localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration);
+        setSearchParams(localVarUrlObj, localVarQueryParameter);
+        const headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+        localVarRequestOptions.headers = {
+            ...localVarHeaderParameter,
+            ...headersFromBaseOptions,
+            ...options.headers,
+        };
+        localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration);
 
-            return {
-                url: toPathString(localVarUrlObj),
-                options: localVarRequestOptions,
-            };
-        },
-    };
-};
+        return {
+            url: toPathString(localVarUrlObj),
+            options: localVarRequestOptions,
+        };
+    },
+});
 
 /**
  * DatumApi - functional programming interface
  * @export
  */
-export const DatumApiFp = function (configuration: Configuration) {
+export const DatumApiFp = (configuration: Configuration) => {
     const localVarAxiosParamCreator = DatumApiAxiosParamCreator(configuration);
     return {
         /**
@@ -134,23 +129,3 @@ export const DatumApiFp = function (configuration: Configuration) {
         },
     };
 };
-
-// /**
-//  * DatumApi - factory interface
-//  * @export
-//  */
-// export const DatumApiFactory = function (configuration: Configuration, basePath?: string, axios?: AxiosInstance) {
-//     const localVarFp = DatumApiFp(configuration);
-//     return {
-//         /**
-//          * Returns the datum corresponding to the specified datum hash, if the datum has been seen on-chain
-//          * @summary Datum by datum hash
-//          * @param {string} datumHash Hex encoded datum hash
-//          * @param {*} [options] Override http request option.
-//          * @throws {RequiredError}
-//          */
-//         lookupDatum(datumHash: string, options?: any): AxiosPromise<TimestampedDatum> {
-//             return localVarFp.lookupDatum(datumHash, options).then((request) => request(axios, basePath));
-//         },
-//     };
-// };