@koine/api 2.0.0-beta.13 → 2.0.0-beta.130

package/createApiResultFail.mjs

@@ -1,7 +0,0 @@
-export const createApiResultFail = (data = {}, msg, status)=>({
-        fail: true,
-        data,
-        msg: msg || "",
-        status: status || 404
-    });
-export default createApiResultFail;

package/createApiResultOk.mjs

@@ -1,8 +0,0 @@
-export const createApiResultOk = (data = {}, msg)=>({
-        ok: true,
-        fail: false,
-        data,
-        msg: msg || "",
-        status: 200
-    });
-export default createApiResultOk;

package/createSwrApi.d.ts

@@ -1,34 +0,0 @@
-import { type BareFetcher, // type Fetcher,
-type SWRConfiguration, type SWRResponse } from "swr";
-import { type SWRMutationConfiguration, type SWRMutationResponse } from "swr/mutation";
-type SWRConfigurationExtended<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.useGet("User/{id}",
-     *  { params: { id: aVariableMaybeContainingAnId || "" }, },
-     *  { when: !!aVariableMaybeContainingAnId }
-     * );
-     *
-     * // we still have typed `data`, `mutate`
-     * ```
-     * @see https://swr.vercel.app/docs/conditional-fetching
-     */
-    when?: boolean | (() => boolean);
-};
-type KoineApiMethodHookSWR<THookName extends keyof Koine.Api.HooksMapsByName, TEndpoints extends Koine.Api.Endpoints> = <TEndpoint extends Koine.Api.EndpointUrl<TEndpoints>, TMethod extends Koine.Api.RequestMethod = Koine.Api.HooksMapsByName[THookName]>(endpoint: TEndpoint, options?: Koine.Api.EndpointOptions<TEndpoints, TEndpoint, TMethod>, config?: THookName extends "useGet" ? SWRConfigurationExtended<Koine.Api.EndpointResponseOk<TEndpoints, TEndpoint, TMethod>, Koine.Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>> : SWRMutationConfiguration<Koine.Api.EndpointResponseOk<TEndpoints, TEndpoint, TMethod>, Koine.Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>, Koine.Api.EndpointOptions<TEndpoints, TEndpoint, TMethod>, TEndpoint>) => THookName extends "useGet" ? SWRResponse<Koine.Api.EndpointResponseOk<TEndpoints, TEndpoint, TMethod>, Koine.Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>> : SWRMutationResponse<Koine.Api.EndpointResponseOk<TEndpoints, TEndpoint, TMethod>, Koine.Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>, Koine.Api.EndpointOptions<TEndpoints, TEndpoint, TMethod>, TEndpoint>;
-/**
- * It creates an api client extended with auto-generated SWR wrapper hooks
- */
-export declare const createSwrApi: <TEndpoints extends Koine.Api.Endpoints>(apiName: string, baseUrl: string, options?: Koine.Api.ClientOptions | undefined) => Koine.Api.Client<TEndpoints> & {
-    useGet: KoineApiMethodHookSWR<"useGet", TEndpoints>;
-    usePost: KoineApiMethodHookSWR<"usePost", TEndpoints>;
-    usePut: KoineApiMethodHookSWR<"usePut", TEndpoints>;
-    usePatch: KoineApiMethodHookSWR<"usePatch", TEndpoints>;
-    useDelete: KoineApiMethodHookSWR<"useDelete", TEndpoints>;
-};
-export default createSwrApi;

package/createSwrApi.mjs

@@ -1,82 +0,0 @@
-"use client";
-import useSWR from "swr";
-import useSWRMutation from "swr/mutation";
-import isFunction from "@koine/utils/isFunction";
-import createApi from "./createApi";
-function createUseApi(api, method) {
-    return function useApi(endpoint, options, _config) {
-        if (method === "get") {
-            // const fetcher = async (_endpoint: TEndpoint) => {
-            //   try {
-            //     const { ok, data } = await api[method](_endpoint, {
-            //         ...(options || {}),
-            //         throwErr: true,
-            //       });
-            //       if (ok) {
-            //         return data;
-            //       }
-            //       throw new Error() as unknown as Koine.Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>;
-            //     } catch(e) {
-            //       throw new Error() as unknown as Koine.Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>;;
-            //     }
-            //   };
-            // }
-            const fetcher = async ()=>{
-                const { data } = await api[method](endpoint, {
-                    ...options || {},
-                    throwErr: true
-                });
-                return data;
-            };
-            const config = _config;
-            const shouldNotFetch = config?.when === false || isFunction(config?.when) && config?.when() === false;
-            // <Data = any, Error = any>(key: Key, config: SWRConfigurationExtended<Data, Error, Fetcher<Data>> | undefined): SWRResponse<Data, Error>;
-            // eslint-disable-next-line react-hooks/rules-of-hooks
-            return useSWR(shouldNotFetch ? null : options ? [
-                endpoint,
-                options
-            ] : [
-                endpoint
-            ], fetcher, config);
-        }
-        const config = _config;
-        const sender = async (// if the first argument is an array the second tem are the base options
-        // defined when calling the usePost/Put/etc. hook, these will be overriden
-        // by the _options just here below
-        _endpoint, // these are the options arriving when calling `trigger({ json, query, etc... })
-        _options)=>{
-            const endpoint = Array.isArray(_endpoint) ? _endpoint[0] : _endpoint;
-            const options = Array.isArray(_endpoint) ? _endpoint[1] : {};
-            const { ok, data } = await api[method](endpoint, {
-                ...options,
-                ..._options.arg || {},
-                throwErr: true
-            });
-            return ok ? data : data;
-        };
-        // config.fetcher = sender;
-        // eslint-disable-next-line react-hooks/rules-of-hooks
-        return useSWRMutation(// @ts-expect-error FIXME: I can't get it...
-        options ? [
-            endpoint,
-            options
-        ] : endpoint, sender, config);
-    };
-}
-/**
- * It creates an api client extended with auto-generated SWR wrapper hooks
- */ export const createSwrApi = (...args)=>{
-    const api = createApi(...args);
-    [
-        "get",
-        "post",
-        "put",
-        "patch",
-        "delete"
-    ].forEach((method)=>{
-        const hookName = `use${method.charAt(0).toUpperCase() + method.slice(1)}`;
-        api[hookName] = createUseApi(api, method);
-    });
-    return api;
-};
-export default createSwrApi;

package/index.mjs

@@ -1,6 +0,0 @@
-export { ApiError } from "./ApiError";
-export { createApi } from "./createApi";
-export { createApiResultFail } from "./createApiResultFail";
-export { createApiResultOk } from "./createApiResultOk";
-export { createSwrApi } from "./createSwrApi";
-export { nextApiResponse12 } from "./nextApiResponse12";

package/nextApiResponse.d.ts

@@ -1,5 +0,0 @@
-export declare const nextApiResponse: {
-    ok<T>(data: T, msg?: string): void;
-    fail<T_1>(data: T_1, msg?: string, status?: number): void;
-};
-export default nextApiResponse;

package/nextApiResponse.mjs

@@ -1,12 +0,0 @@
-import { NextResponse } from "next/server";
-import createApiResultFail from "./createApiResultFail";
-import createApiResultOk from "./createApiResultOk";
-export const nextApiResponse = {
-    ok (data, msg) {
-        NextResponse.json(createApiResultOk(data, msg));
-    },
-    fail (data, msg, status) {
-        NextResponse.json(createApiResultFail(data, msg, status));
-    }
-};
-export default nextApiResponse;

package/nextApiResponse12.d.ts

@@ -1,6 +0,0 @@
-import type { NextApiResponse } from "next";
-export declare const nextApiResponse12: (nextRes: NextApiResponse) => {
-    ok<T>(data: T, msg?: string): void;
-    fail<T_1>(data: T_1, msg?: string, status?: number): void;
-};
-export default nextApiResponse12;

package/nextApiResponse12.mjs

@@ -1,13 +0,0 @@
-import createApiResultFail from "./createApiResultFail";
-import createApiResultOk from "./createApiResultOk";
-export const nextApiResponse12 = (nextRes)=>{
-    return {
-        ok (data, msg) {
-            nextRes.status(200).json(createApiResultOk(data, msg));
-        },
-        fail (data, msg, status) {
-            nextRes.status(status || 404).json(createApiResultFail(data, msg, status));
-        }
-    };
-};
-export default nextApiResponse12;