@koine/api 1.0.15 → 1.0.18

package/README.md

@@ -1,5 +1 @@
-# @koine/utils
-
-## Code
-
-- Transformative functions like `truncate` or `titleCase` should allow for nullable inputs as much as possible, acceptin both `undefined` and `null`.
+# @koine/api

package/core/index.js

@@ -83,7 +83,7 @@ export var createApi = function (apiName, baseUrl, options) {
                     case 8:
                         _f.trys.push([8, 13, , 14]);
                         if (!adapter) return [3 /*break*/, 10];
-                        return [4 /*yield*/, adapter(response, options)];
+                        return [4 /*yield*/, adapter(response, options || {})];
                     case 9:
                         result = _f.sent();
                         return [3 /*break*/, 12];
@@ -99,7 +99,7 @@ export var createApi = function (apiName, baseUrl, options) {
                     case 14: return [3 /*break*/, 19];
                     case 15:
                         if (!adapter) return [3 /*break*/, 17];
-                        return [4 /*yield*/, adapter(response, options)];
+                        return [4 /*yield*/, adapter(response, options || {})];
                     case 16:
                         result = _f.sent();
                         return [3 /*break*/, 19];

package/node/core/index.js

@@ -86,7 +86,7 @@ var createApi = function (apiName, baseUrl, options) {
                     case 8:
                         _f.trys.push([8, 13, , 14]);
                         if (!adapter) return [3 /*break*/, 10];
-                        return [4 /*yield*/, adapter(response, options)];
+                        return [4 /*yield*/, adapter(response, options || {})];
                     case 9:
                         result = _f.sent();
                         return [3 /*break*/, 12];
@@ -102,7 +102,7 @@ var createApi = function (apiName, baseUrl, options) {
                     case 14: return [3 /*break*/, 19];
                     case 15:
                         if (!adapter) return [3 /*break*/, 17];
-                        return [4 /*yield*/, adapter(response, options)];
+                        return [4 /*yield*/, adapter(response, options || {})];
                     case 16:
                         result = _f.sent();
                         return [3 /*break*/, 19];

package/package.json

@@ -4,14 +4,13 @@
   "main": "./node/index.js",
   "typings": "./index.d.ts",
   "dependencies": {
-    "@koine/utils": "1.0.15",
+    "@koine/utils": "1.0.18",
     "next": "^12.1.6",
     "swr": "^2.0.0-beta.3",
-    "type-fest": "^2.13.0",
     "tslib": "^2.4.0"
   },
   "peerDependencies": {},
-  "version": "1.0.15",
+  "version": "1.0.18",
   "module": "./index.js",
   "types": "./index.d.ts"
 }

package/typings.d.ts

@@ -4,7 +4,7 @@ type _Response = Response;
 
 declare namespace Koine.Api {
   // @see https://stackoverflow.com/a/60702896/1938970
-  import { Exact } from "type-fest";
+  // import { Exact } from "type-fest";
 
   //////////////////////////////////////////////////////////////////////////////
   //
@@ -48,7 +48,7 @@ declare namespace Koine.Api {
   /**
    * The `api` interface generated by `createApi`
    */
-  type Client<TEndpoints> = {
+  type Client<TEndpoints extends Endpoints> = {
     [TMethod in RequestMethod]: ClientMethod<TMethod, TEndpoints>;
   };
 
@@ -112,9 +112,11 @@ declare namespace Koine.Api {
   //   T : "Endpoint must follow `Koine.Api.Endpoint` shape" : never;
   type DefineEndpoint<T extends EndpointShape> = T;
   type DefineEndpoints<T extends Endpoints> = {};
-  type EndpointShape = { [TMethod in Uppercase<RequestMethod>]?: DataTypes };
+  type EndpointShape = {
+    [TMethod in Uppercase<RequestMethod>]?: DataTypes<TMethod>;
+  };
 
-  type Endpoints = readonly Record<string, Endpoint>;
+  type Endpoints = Record<string, Endpoint>;
   type Endpoint = {
     [TMethod in Uppercase<RequestMethod>]?: DataTypes<TMethod>;
   };
@@ -124,42 +126,25 @@ declare namespace Koine.Api {
     string
   >;
 
-  type DataTypes<TMethod extends Uppercase<RequestMethod>> =
-    TMethod extends "GET"
-      ? {
-          /**
-           * The JSON response data returned by the request in case of success
-           */
-          response?: null | unknown;
-          /**
-           * The parameters to encode in the URL of the request
-           */
-          params?: RequestParams;
-          /**
-           * The shape of the error data returned by the request in case of
-           * failure
-           */
-          error?: null | unknown;
-        }
-      : {
-          /**
-           * The request body of a non-GET request
-           */
-          request?: null | unknown;
-          /**
-           * The JSON response data returned by the request in case of success
-           */
-          response?: null | unknown;
-          /**
-           * The parameters to encode in the URL of the request
-           */
-          params?: RequestParams;
-          /**
-           * The shape of the error data returned by the request in case of
-           * failure
-           */
-          error?: null | unknown;
-        };
+  type DataTypes<TMethod extends Uppercase<RequestMethod>> = {
+    /**
+     * The request body of a non-GET request
+     */
+    request?: RequestJson;
+    /**
+     * The JSON response data returned by the request in case of success
+     */
+    response?: null | unknown;
+    /**
+     * The parameters to encode in the URL of the request
+     */
+    params?: RequestParams;
+    /**
+     * The shape of the error data returned by the request in case of
+     * failure
+     */
+    error?: null | unknown;
+  };
 
   //////////////////////////////////////////////////////////////////////////////
   //
@@ -167,6 +152,8 @@ declare namespace Koine.Api {
   //
   //////////////////////////////////////////////////////////////////////////////
 
+  type RequestJson = undefined | null | Record<string | number, unknown>;
+
   type RequestParams = undefined | null | Record<string | number, unknown>;
 
   /**
@@ -285,7 +272,7 @@ declare namespace Koine.Api {
     Failed extends DataFailed = DataFailed
   >(
     response: _Response,
-    options: RequestOptions
+    options: TOptions
   ) => Promise<Koine.Api.Response<Succesfull, Failed>>;
 
   //////////////////////////////////////////////////////////////////////////////
@@ -301,9 +288,101 @@ declare namespace Koine.Api {
    * These hooks are implemented with different libraries or, in the future as
    * standalone hooks, see SWR ones to start with.
    */
-  type HooksMaps = readonly {
+  type HooksMaps = {
     [TMethod in RequestMethod]: `use${Capitalize<TMethod>}`;
   };
 
-  type HooksMapsByName = readonly { [K in keyof HooksMaps as HooksMaps[K]]: K };
+  type HooksMapsByName = { [K in keyof HooksMaps as HooksMaps[K]]: K };
+
+  //////////////////////////////////////////////////////////////////////////////
+  //
+  // Generate shortcuts
+  //
+  //////////////////////////////////////////////////////////////////////////////
+
+  /**
+   * To generate all available helpers use in your `API` types:
+   *
+   * ```ts
+   * type Response = Koine.Api.GenerateResponseHelpers<Endpoints>;
+   * type Request = Koine.Api.GenerateRequestHelpers<Endpoints>;
+   * type Get = Koine.Api.GenerateGetHelpers<Endpoints>;
+   * type Post = Koine.Api.GeneratePostHelpers<Endpoints>;
+   * ```
+   */
+  type Generate = "here just to read the example usage";
+
+  type _ShortcutsMaps = {
+    [TMethod in RequestMethod]: Capitalize<TMethod>;
+  };
+
+  type _ShortcutsMapsByMethod = {
+    [K in keyof _ShortcutsMaps as _ShortcutsMaps[K]]: K;
+  };
+
+  /**
+   * @example
+   * ```ts
+   * // define the type on your `API` types:
+   * type Response = Koine.Api.GenerateResponseShortcuts<Endpoints>;
+   *
+   * // consume the type wherever in your app:
+   * type MyData = API.Response["get"]["my/endpoint"];
+   * ```
+   */
+  type GenerateResponseShortcuts<TEndpoints extends Endpoints> = {
+    [TMethod in RequestMethod]: {
+      [TEndpointUrl in keyof TEndpoints]: TEndpoints[TEndpointUrl][Uppercase<TMethod>]["response"];
+    };
+  };
+
+  /**
+   * @example
+   * ```ts
+   * // define the type on your `API` types:
+   * type Get = Koine.Api.GenerateResponseShortcuts<Endpoints>;
+   *
+   * // consume the type wherever in your app:
+   * type MyData = API.Get["my/endpoint"];
+   * ```
+   */
+  type GenerateGetShortcuts<TEndpoints extends Endpoints> = {
+    [TEndpointUrl in keyof TEndpoints]: TEndpoints[TEndpointUrl]["GET"]["response"];
+  };
+
+  /**
+   * @example
+   * ```ts
+   * // define the type on your `API` types:
+   * type Post = Koine.Api.GenerateResponseShortcuts<Endpoints>;
+   *
+   * // consume the type wherever in your app:
+   * type MyData = API.Post["my/endpoint"];
+   * ```
+   */
+  type GeneratePostShortcuts<TEndpoints extends Endpoints> = {
+    [TEndpointUrl in keyof TEndpoints]: TEndpoints[TEndpointUrl]["POST"]["response"];
+  };
+
+  /**
+   * This is not useful as it is the same as doing
+   * `API.Endpoints["my/endpoint"]["GET"]["response"];`
+   *
+   * @example
+   * ```ts
+   * // define the type on your `API` types:
+   * type Response = Koine.Api.GenerateResponseShortcuts<Endpoints>;
+   *
+   * // consume the type wherever in your app:
+   * type MyData = API.$["my/endpoint"]["get"]["response"];
+   * ```
+   * @deprecated
+   */
+  // type GenerateAllShortcuts<TEndpoints extends Endpoints> = {
+  //   [TEndpointUrl in keyof TEndpoints]: {
+  //     [TMethod in RequestMethod]: {
+  //       [DataType in EndpointDataType]: TEndpoints[TEndpointUrl][Uppercase<TMethod>][DataType];
+  //     }
+  //   }
+  // }
 }