Fix types for Client

Author: Immanuel Pelzer

CHANGELOG.md

@@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+# [5.4.2] - 2023-07-26
+
+- Fix `Client` types
+
 # [5.4.1] - 2023-07-26
 
 - Refactor errors and improve Error types

bin/generate-type-definitions.sh

@@ -3,6 +3,6 @@
 # This generate the type definitions for all files
 npx -p typescript tsc lib/index.js lib/**/*.js --declaration --allowJs --emitDeclarationOnly --outFile lib/index.d.ts --module node16 --esModuleInterop --skipLibCheck
 # Rename the library (we put "taube" instead of "@unu/taube")
-sed -i 's/declare module "index" {/declare module "@unu\/taube" {/' lib/index.d.ts
+sed -i '' 's/declare module "index" {/declare module "@unu\/taube" {/' lib/index.d.ts
 # Remove all ".js" endings to fix the pathing. the generator adds these for some reason
-sed -i 's/\.js//g' lib/index.d.ts
+sed -i '' 's/\.js//g' lib/index.d.ts

lib/components/client.js

@@ -41,6 +41,13 @@ class Client {
     return uri.href
   }
 
+  /**
+   * GET an endpoint
+   *
+   * @param {string} path URL path. e.g. /items
+   * @param {Object} options Options passed directly to got
+   * @returns {Promise<any>} The response of the query
+   */
   async get(path, options = {}) {
     if (options?.query) {
       options.searchParams = options.query
@@ -59,6 +66,13 @@ class Client {
     }
   }
 
+  /**
+   * GET an endpoint that returns a paginated list
+   *
+   * @param {string} path URL path. e.g. /items
+   * @param {Object} options Options passed directly to got
+   * @returns {Promise<any>} The response of the query
+   */
   async paginate(path, options = {}) {
     options = { ...paginationDefaultOptions, ...options }
     try {
@@ -73,6 +87,14 @@ class Client {
     }
   }
 
+  /**
+   * POST an endpoint
+   *
+   * @param {string} path URL path. e.g. /items
+   * @param {Object} payload The payload to POST
+   * @param {Object} options Options passed directly to got
+   * @returns {Promise<any>} The response of the query
+   */
   async post(path, payload, options = {}) {
     if (options?.query) {
       options.searchParams = options.query
@@ -93,6 +115,14 @@ class Client {
     }
   }
 
+  /**
+   * PUT an endpoint
+   *
+   * @param {string} path URL path. e.g. /items
+   * @param {Object} payload The payload to POST
+   * @param {Object} options Options passed directly to got
+   * @returns {Promise<any>} The response of the query
+   */
   async put(path, payload, options = {}) {
     if (options?.query) {
       options.searchParams = options.query
@@ -113,6 +143,13 @@ class Client {
     }
   }
 
+  /**
+   * DELETE an endpoint
+   *
+   * @param {string} path URL path. e.g. /items
+   * @param {Object} options Options passed directly to got
+   * @returns {Promise<any>} The response of the query
+   */
   async delete(path, options = {}) {
     if (options?.query) {
       options.searchParams = options.query

lib/index.d.ts

@@ -67,6 +67,18 @@ declare module "components/requester" {
     }
 }
 declare module "components/errors" {
+    export class TaubeError extends Error {
+        constructor(message: any, data?: any);
+        data: any;
+        isTaubeError: boolean;
+        statusCode: any;
+        toJSON(): {
+            message: string;
+            name: string;
+            statusCode: any;
+            data: any;
+        };
+    }
     export function convertToTaubeError(error: Error): any;
     export default errors;
     const errors: {
@@ -2319,11 +2331,48 @@ declare module "components/client" {
         uri: any;
         port: string | number;
         makePath(path: any, params?: {}): string;
-        get(path: any, options?: {}): Promise<string>;
-        paginate(path: any, options?: {}): Promise<string>;
-        post(path: any, payload: any, options?: {}): Promise<string>;
-        put(path: any, payload: any, options?: {}): Promise<string>;
-        delete(path: any, options?: {}): Promise<string>;
+        /**
+         * GET an endpoint
+         *
+         * @param {string} path URL path. e.g. /items
+         * @param {Object} options Options passed directly to got
+         * @returns {Promise<any>} The response of the query
+         */
+        get(path: string, options?: any): Promise<any>;
+        /**
+         * GET an endpoint that returns a paginated list
+         *
+         * @param {string} path URL path. e.g. /items
+         * @param {Object} options Options passed directly to got
+         * @returns {Promise<any>} The response of the query
+         */
+        paginate(path: string, options?: any): Promise<any>;
+        /**
+         * POST an endpoint
+         *
+         * @param {string} path URL path. e.g. /items
+         * @param {Object} payload The payload to POST
+         * @param {Object} options Options passed directly to got
+         * @returns {Promise<any>} The response of the query
+         */
+        post(path: string, payload: any, options?: any): Promise<any>;
+        /**
+         * PUT an endpoint
+         *
+         * @param {string} path URL path. e.g. /items
+         * @param {Object} payload The payload to POST
+         * @param {Object} options Options passed directly to got
+         * @returns {Promise<any>} The response of the query
+         */
+        put(path: string, payload: any, options?: any): Promise<any>;
+        /**
+         * DELETE an endpoint
+         *
+         * @param {string} path URL path. e.g. /items
+         * @param {Object} options Options passed directly to got
+         * @returns {Promise<any>} The response of the query
+         */
+        delete(path: string, options?: any): Promise<any>;
     }
 }
 declare module "helpers/schema" {

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@unu/taube",
-  "version": "5.4.1",
+  "version": "5.4.2",
   "type": "module",
   "exports": "./lib/index.js",
   "engines": {