@xy-planning-network/trees 0.4.7 → 0.4.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xy-planning-network/trees",
-  "version": "0.4.7",
+  "version": "0.4.8",
   "description": "",
   "license": "MIT",
   "repository": "github:xy-planning-network/trees",
@@ -58,7 +58,7 @@
   "dependencies": {
     "@headlessui/vue": "^1.4.2",
     "@heroicons/vue": "^1.0.5",
-    "axios": "^0.21.4",
+    "axios": "^0.27.2",
     "flatpickr": "^4.6.9"
   },
   "peerDependencies": {

package/types/api/base.d.ts

@@ -1,12 +1,24 @@
-import { AxiosPromise, AxiosRequestConfig } from "axios";
-export interface RequestOptions {
+import { AxiosRequestConfig } from "axios";
+export declare type RequestMethod = "GET" | "get" | "PUT" | "put" | "POST" | "post" | "DELETE" | "delete";
+export interface RequestOptions extends AxiosRequestConfig {
+    /**
+     * returns the nested data key inside the AxiosResponse data when true
+     */
+    dataIntercept?: boolean;
+    /**
+     * disables the full screen loading interface during the request when true
+     */
     skipLoader?: boolean;
+    /**
+     * artificially delay's the request by the time specified when set
+     */
+    withDelay?: number;
 }
 declare const BaseAPI: {
-    makeRequest(config: AxiosRequestConfig, opts: RequestOptions): AxiosPromise;
-    get(path: string, opts: RequestOptions, params?: Record<string, unknown> | undefined): AxiosPromise;
-    delete(path: string, opts: RequestOptions): AxiosPromise;
-    post(path: string, data: Record<string, unknown>, opts: RequestOptions): AxiosPromise;
-    put(path: string, data: Record<string, unknown>, opts: RequestOptions): AxiosPromise;
+    makeRequest<T = any>(opts: RequestOptions): Promise<T>;
+    get<T_1 = any>(path: string, opts: RequestOptions, params?: Record<string, unknown> | undefined): Promise<T_1>;
+    delete<T_2 = any>(path: string, opts: RequestOptions): Promise<T_2>;
+    post<T_3 = any>(path: string, data: Record<string, unknown>, opts: RequestOptions): Promise<T_3>;
+    put<T_4 = any>(path: string, data: Record<string, unknown>, opts: RequestOptions): Promise<T_4>;
 };
 export default BaseAPI;

package/types/composables/index.d.ts

@@ -0,0 +1,4 @@
+import { default as useBaseAPI, useBaseAPIGet, useBaseAPIPut, useBaseAPIPost, useBaseAPIDelete } from "./useBaseAPI";
+import type { UseBaseAPIOptions, UseBaseAPI } from "./useBaseAPI";
+export type { UseBaseAPIOptions, UseBaseAPI };
+export { useBaseAPI, useBaseAPIGet, useBaseAPIPut, useBaseAPIPost, useBaseAPIDelete, };

package/types/composables/useBaseAPI.d.ts

@@ -0,0 +1,105 @@
+import { AxiosError } from "axios";
+import { Ref, ShallowRef } from "vue";
+import type { RequestMethod, RequestOptions } from "../api/base";
+/**
+ * UseBaseAPIOptions extends Trees/RequestOptions
+ * these options are used only in the instantiation
+ * of a new UseBaseAPI composable
+ */
+export interface UseBaseAPIOptions extends RequestOptions {
+    /**
+     * Whether to immediately fire the execute function during instantiation
+     */
+    immediate?: boolean;
+}
+/**
+ * UseBaseAPI is a composable the wraps up the
+ * usage of Trees/BaseAPI and returns reactive
+ * state variables along with reusaable execute and abort functions
+ */
+export interface UseBaseAPI<T> {
+    /**
+     * Axios response data
+     */
+    result: Ref<T | undefined>;
+    /**
+     * Any errors that may have occurred
+     */
+    error: ShallowRef<Error | AxiosError<T> | undefined>;
+    /**
+     * Indicates if the request has finished
+     */
+    isFinished: Ref<boolean>;
+    /**
+     * Indicates if the request is currently loading
+     */
+    isLoading: Ref<boolean>;
+    /**
+     * Indicates if the request was canceled
+     */
+    isAborted: Ref<boolean>;
+    /**
+     * Indicates if a first request has completed
+     */
+    hasFetched: Ref<boolean>;
+    /**
+     * Aborts the current request
+     * can be used multiple times
+     */
+    abort: () => void;
+    /**
+     * Manually call the axios request
+     * can be used multiple times
+     */
+    execute: (data?: Record<string, unknown>, opts?: RequestOptions) => Promise<T>;
+}
+/**
+ * useBaseAPI is a composable wrapper of BaseAPI
+ * @param path {string} the api path or full url for the
+ * @param method {RequestMethod} the initial request type
+ * @param initOpts {UseBaseAPIOptions}
+ * @param initConfig {AxiosRequestConfig}
+ * @returns {UseBaseAPI<T>}
+ */
+export default function useBaseAPI<T = any>(path: string, method?: RequestMethod, initOpts?: UseBaseAPIOptions): {
+    result: Ref<T | undefined>;
+    error: ShallowRef<Error | AxiosError<T, any> | undefined>;
+    isFinished: Ref<boolean>;
+    isLoading: Ref<boolean>;
+    isAborted: Ref<boolean>;
+    hasFetched: Ref<boolean>;
+    abort: () => void;
+    execute: (data?: Record<string, unknown>, opts?: RequestOptions) => Promise<T>;
+};
+/**
+ * useBaseAPIGet is a convenience function for useBaseAPI
+ * @param path {string} the api path or full url for the
+ * @param initOpts {UseBaseAPIOptions}
+ * @param initConfig {AxiosRequestConfig}
+ * @returns {UseBaseAPI<T>}
+ */
+export declare function useBaseAPIGet<T = any>(url: string, opts?: UseBaseAPIOptions): UseBaseAPI<T>;
+/**
+ * useBaseAPIDelete is a convenience function for useBaseAPI
+ * @param path {string} the api path or full url for the
+ * @param initOpts {UseBaseAPIOptions}
+ * @param initConfig {AxiosRequestConfig}
+ * @returns {UseBaseAPI<T>}
+ */
+export declare function useBaseAPIDelete<T = any>(url: string, opts?: UseBaseAPIOptions): UseBaseAPI<T>;
+/**
+ * useBaseAPIPost is a convenience function for useBaseAPI
+ * @param path {string} the api path or full url for the
+ * @param initOpts {UseBaseAPIOptions}
+ * @param initConfig {AxiosRequestConfig}
+ * @returns {UseBaseAPI<T>}
+ */
+export declare function useBaseAPIPost<T = any>(url: string, opts?: UseBaseAPIOptions): UseBaseAPI<T>;
+/**
+ * useBaseAPIPut is a convenience function for useBaseAPI
+ * @param path {string} the api path or full url for the
+ * @param initOpts {UseBaseAPIOptions}
+ * @param initConfig {AxiosRequestConfig}
+ * @returns {UseBaseAPI<T>}
+ */
+export declare function useBaseAPIPut<T = any>(url: string, opts?: UseBaseAPIOptions): UseBaseAPI<T>;

package/types/entry.d.ts

@@ -1,6 +1,9 @@
 import { Plugin } from "vue";
 import BaseAPI from "./api/base";
+import type { RequestOptions } from "./api/base";
 declare const install: Exclude<Plugin["install"], undefined>;
 export default install;
+export * from "./composables/index";
 export * from "./lib-components/index";
 export { BaseAPI };
+export type { RequestOptions };

package/types/helpers/Debounce.d.ts

@@ -1 +1,2 @@
 export declare function debounce(func: () => void, timeout?: number): () => void;
+export declare function debounceLeading(func: () => void, timeout?: number): (...args: any[]) => void;