@xy-planning-network/trees 0.4.8-rc-2 → 0.4.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xy-planning-network/trees",
-  "version": "0.4.8-rc-2",
+  "version": "0.4.8",
   "description": "",
   "license": "MIT",
   "repository": "github:xy-planning-network/trees",

package/types/api/base.d.ts

@@ -1,15 +1,21 @@
-import { AxiosResponse, AxiosRequestConfig } from "axios";
+import { AxiosRequestConfig } from "axios";
 export declare type RequestMethod = "GET" | "get" | "PUT" | "put" | "POST" | "post" | "DELETE" | "delete";
-export interface TreesResponse<T> extends AxiosResponse<T> {
-    data: T;
-}
-export interface RequestOptions {
+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<T = any>(config: AxiosRequestConfig, opts: RequestOptions): Promise<T>;
+    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>;

package/types/composables/useBaseAPI.d.ts

@@ -1,4 +1,4 @@
-import { AxiosError, AxiosRequestConfig } from "axios";
+import { AxiosError } from "axios";
 import { Ref, ShallowRef } from "vue";
 import type { RequestMethod, RequestOptions } from "../api/base";
 /**
@@ -51,7 +51,7 @@ export interface UseBaseAPI<T> {
      * Manually call the axios request
      * can be used multiple times
      */
-    execute: (data?: Record<string, unknown>, opts?: RequestOptions, config?: AxiosRequestConfig) => Promise<T>;
+    execute: (data?: Record<string, unknown>, opts?: RequestOptions) => Promise<T>;
 }
 /**
  * useBaseAPI is a composable wrapper of BaseAPI
@@ -61,7 +61,7 @@ export interface UseBaseAPI<T> {
  * @param initConfig {AxiosRequestConfig}
  * @returns {UseBaseAPI<T>}
  */
-export default function useBaseAPI<T = any>(path: string, method?: RequestMethod, initOpts?: UseBaseAPIOptions, initConfig?: AxiosRequestConfig): {
+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>;
@@ -69,7 +69,7 @@ export default function useBaseAPI<T = any>(path: string, method?: RequestMethod
     isAborted: Ref<boolean>;
     hasFetched: Ref<boolean>;
     abort: () => void;
-    execute: (data?: Record<string, unknown>, execOpts?: RequestOptions, execConfig?: AxiosRequestConfig) => Promise<T>;
+    execute: (data?: Record<string, unknown>, opts?: RequestOptions) => Promise<T>;
 };
 /**
  * useBaseAPIGet is a convenience function for useBaseAPI
@@ -78,7 +78,7 @@ export default function useBaseAPI<T = any>(path: string, method?: RequestMethod
  * @param initConfig {AxiosRequestConfig}
  * @returns {UseBaseAPI<T>}
  */
-export declare function useBaseAPIGet<T = any>(url: string, initOpts?: UseBaseAPIOptions, initConfig?: AxiosRequestConfig): 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
@@ -86,7 +86,7 @@ export declare function useBaseAPIGet<T = any>(url: string, initOpts?: UseBaseAP
  * @param initConfig {AxiosRequestConfig}
  * @returns {UseBaseAPI<T>}
  */
-export declare function useBaseAPIDelete<T = any>(url: string, initOpts?: UseBaseAPIOptions, initConfig?: AxiosRequestConfig): 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
@@ -94,7 +94,7 @@ export declare function useBaseAPIDelete<T = any>(url: string, initOpts?: UseBas
  * @param initConfig {AxiosRequestConfig}
  * @returns {UseBaseAPI<T>}
  */
-export declare function useBaseAPIPost<T = any>(url: string, initOpts?: UseBaseAPIOptions, initConfig?: AxiosRequestConfig): 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
@@ -102,4 +102,4 @@ export declare function useBaseAPIPost<T = any>(url: string, initOpts?: UseBaseA
  * @param initConfig {AxiosRequestConfig}
  * @returns {UseBaseAPI<T>}
  */
-export declare function useBaseAPIPut<T = any>(url: string, initOpts?: UseBaseAPIOptions, initConfig?: AxiosRequestConfig): UseBaseAPI<T>;
+export declare function useBaseAPIPut<T = any>(url: string, opts?: UseBaseAPIOptions): UseBaseAPI<T>;

package/types/entry.d.ts

@@ -1,7 +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/types/lists.d.ts

@@ -1,12 +0,0 @@
-export interface Pagination {
-    page: number;
-    perPage: number;
-    totalItems: number;
-    totalPages: number;
-}
-export interface PaginationItems<T = any> {
-    items: T[];
-}
-export interface PaginationData<T = any> {
-    data: Pagination & PaginationItems<T>;
-}