@koine/api 2.0.0-beta.160 → 2.0.0-beta.161

package/createApi.d.ts

@@ -3,7 +3,7 @@ import type { Api } from "./types";
  * Create api client
  *
  * @param apiName Short name to use in debug logs
- * @param baseUrl Either relativ eor absolute, it must end without trailing slash
+ * @param baseUrl Either relative or absolute, it must end without trailing slash
  */
 export declare let createApi: <TEndpoints extends Api.Endpoints>(apiName: string, baseUrl: string, defaultOptions?: Api.ClientOptions) => Api.Client<TEndpoints>;
 export default createApi;

package/package.json

@@ -74,7 +74,7 @@
     }
   },
   "dependencies": {
-    "@koine/utils": "2.0.0-beta.160"
+    "@koine/utils": "2.0.0-beta.161"
   },
   "peerDependencies": {
     "next": "^14.0.4",
@@ -91,5 +91,5 @@
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
   "types": "./index.esm.d.ts",
-  "version": "2.0.0-beta.160"
+  "version": "2.0.0-beta.161"
 }

package/swr/createSwrApi.d.ts

@@ -1,32 +1,41 @@
 import { type BareFetcher, type SWRConfiguration, type SWRResponse } from "swr";
 import type { Api } from "../types";
-type SWRConfigurationExtended<Data = any, Error = any, Fn extends BareFetcher<any> = BareFetcher<any>> = SWRConfiguration<Data, Error, Fn> & {
+export declare namespace ApiSWR {
+    type ConfigurationExtended<Data = any, Error = any, Fn extends BareFetcher<any> = BareFetcher<any>> = SWRConfiguration<Data, Error, Fn> & {
+        /**
+         * Conditional fetching as option
+         *
+         * Moving this to an option allows us to keep the endpoints typed dictionary,
+         * e.g. we can write:
+         *
+         * ```js
+         * const { data, mutate } = myApi.use("User/{id}",
+         *  { params: { id: aVariableMaybeContainingAnId || "" }, },
+         *  { when: !!aVariableMaybeContainingAnId }
+         * );
+         *
+         * // we still have typed `data`, `mutate`
+         * ```
+         * @see https://swr.vercel.app/docs/conditional-fetching
+         */
+        when?: boolean | (() => boolean);
+    };
     /**
-     * Conditional fetching as option
-     *
-     * Moving this to an option allows us to keep the endpoints typed dictionary,
-     * e.g. we can write:
-     *
-     * ```js
-     * const { data, mutate } = myApi.use("User/{id}",
-     *  { params: { id: aVariableMaybeContainingAnId || "" }, },
-     *  { when: !!aVariableMaybeContainingAnId }
-     * );
-     *
-     * // we still have typed `data`, `mutate`
-     * ```
-     * @see https://swr.vercel.app/docs/conditional-fetching
+     * The `api` interface generated by `createApi`
      */
-    when?: boolean | (() => boolean);
-};
+    type Client<TEndpoints extends Api.Endpoints> = Api.Client<TEndpoints> & {
+        use: ReturnType<typeof createUseApi<TEndpoints>>;
+    };
+}
 /**
  * @private
  */
-export declare let createUseApi: <TEndpoints extends Api.Endpoints>(api: Api.Client<TEndpoints>, defaultSwrConfig?: SWRConfigurationExtended) => <TEndpoint extends Api.EndpointUrl<TEndpoints>>(endpoint: TEndpoint, options?: Api.EndpointOptions<TEndpoints, TEndpoint, "get">, swrConfig?: SWRConfigurationExtended<Api.EndpointResponseOk<TEndpoints, TEndpoint, "get">, Api.EndpointResponseFail<TEndpoints, TEndpoint, "get">>) => SWRResponse<Api.EndpointResponseOk<TEndpoints, TEndpoint, "get">, Api.EndpointResponseFail<TEndpoints, TEndpoint, "get">>;
+export declare let createUseApi: <TEndpoints extends Api.Endpoints>(api: Api.Client<TEndpoints>, defaultSwrConfig?: ApiSWR.ConfigurationExtended) => <TEndpoint extends Api.EndpointUrl<TEndpoints>>(endpoint: TEndpoint, options?: Api.EndpointOptions<TEndpoints, TEndpoint, "get">, swrConfig?: ApiSWR.ConfigurationExtended<Api.EndpointResponseOk<TEndpoints, TEndpoint, "get">, Api.EndpointResponseFail<TEndpoints, TEndpoint, "get">>) => SWRResponse<Api.EndpointResponseOk<TEndpoints, TEndpoint, "get">, Api.EndpointResponseFail<TEndpoints, TEndpoint, "get">>;
 /**
  * It creates an api client extended with auto-generated SWR wrapper hooks
+ *
+ * @param apiName Short name to use in debug logs
+ * @param baseUrl Either relative or absolute, it must end without trailing slash
  */
-export declare let createSwrApi: <TEndpoints extends Api.Endpoints>(apiName: string, baseUrl: string, defaultOptions?: Api.ClientOptions, defaultSwrConfig?: SWRConfigurationExtended) => Api.Client<TEndpoints> & {
-    use: ReturnType<typeof createUseApi<TEndpoints>>;
-};
+export declare let createSwrApi: <TEndpoints extends Api.Endpoints>(apiName: string, baseUrl: string, defaultOptions?: Api.ClientOptions, defaultSwrConfig?: ApiSWR.ConfigurationExtended) => ApiSWR.Client<TEndpoints>;
 export default createSwrApi;

package/swr.d.ts

@@ -1 +1 @@
-export { createSwrApi } from "./swr/createSwrApi";
+export { createSwrApi, type ApiSWR } from "./swr/createSwrApi";