@xy-planning-network/trees 0.6.0 → 0.7.0-rc-1

package/package.json

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

package/src/lib-components/lists/Table.vue

@@ -1,5 +1,4 @@
 <script setup lang="ts">
-import { AxiosResponse } from "axios"
 import {
   ComponentPublicInstance,
   computed,
@@ -97,7 +96,7 @@ const loadAndRender = (): void => {
   }
 
   BaseAPI.get(props.tableData.url, { skipLoader: !props.loader }, params).then(
-    (success: AxiosResponse) => {
+    (success) => {
       pagination.value = {
         page: success.data.page,
         perPage: success.data.perPage,

package/types/api/base.d.ts

@@ -1,10 +1,22 @@
+import { Pagination } from "../composables/nav";
 import { AxiosRequestConfig } from "axios";
-export declare type RequestMethod = "GET" | "get" | "PUT" | "put" | "POST" | "post" | "DELETE" | "delete";
-export interface RequestOptions {
+export interface Paginated<T> extends Pagination {
+    items: T[];
+}
+export interface TreesResponse<T = any> {
+    /**
+     * response data as T
+     */
+    data: T;
     /**
-     * returns the nested data key inside the AxiosResponse data when true
+     * http status code
      */
-    dataIntercept?: boolean;
+    status: number;
+}
+export interface TreesPromise<T = any> extends Promise<TreesResponse<T>> {
+}
+export declare type RequestMethod = "GET" | "get" | "PUT" | "put" | "POST" | "post" | "DELETE" | "delete";
+export interface RequestOptions {
     /**
      * disables the full screen loading interface during the request when true
      */
@@ -15,10 +27,10 @@ export interface RequestOptions {
     withDelay?: number;
 }
 declare const BaseAPI: {
-    makeRequest<T = any>(config: AxiosRequestConfig, 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> | FormData, opts: RequestOptions): Promise<T_3>;
-    put<T_4 = any>(path: string, data: Record<string, unknown> | FormData, opts: RequestOptions): Promise<T_4>;
+    makeRequest<T = any>(config: AxiosRequestConfig, opts: RequestOptions): TreesPromise<T>;
+    get<T_1 = any>(path: string, opts: RequestOptions, params?: Record<string, unknown> | undefined): TreesPromise<T_1>;
+    delete<T_2 = any>(path: string, opts: RequestOptions): TreesPromise<T_2>;
+    post<T_3 = any>(path: string, data: Record<string, unknown> | FormData, opts: RequestOptions): TreesPromise<T_3>;
+    put<T_4 = any>(path: string, data: Record<string, unknown> | FormData, opts: RequestOptions): TreesPromise<T_4>;
 };
 export default BaseAPI;

package/types/api/url.d.ts

@@ -0,0 +1 @@
+export declare function getBaseUrl(): string;

package/types/composables/useBaseAPI.d.ts

@@ -1,5 +1,6 @@
 import { AxiosError } from "axios";
 import { Ref, ShallowRef } from "vue";
+import { TreesPromise } from "../api/base";
 import type { RequestMethod, RequestOptions } from "../api/base";
 /**
  * UseBaseAPIOptions extends Trees/RequestOptions
@@ -19,13 +20,17 @@ export interface UseBaseAPIOptions extends RequestOptions {
  */
 export interface UseBaseAPI<T> {
     /**
-     * Axios response data
+     * Promise response data
      */
     result: Ref<T | undefined>;
     /**
-     * Any errors that may have occurred
+     * Promise response http status code
      */
-    error: ShallowRef<Error | AxiosError<T> | undefined>;
+    status: Ref<number | undefined>;
+    /**
+     * Any errors or rejections that may have occurred
+     */
+    error: ShallowRef<AxiosError | Error | undefined>;
     /**
      * Indicates if the request has finished
      */
@@ -51,7 +56,7 @@ export interface UseBaseAPI<T> {
      * Manually call the axios request
      * can be used multiple times
      */
-    execute: (data?: Record<string, unknown> | FormData, opts?: RequestOptions) => Promise<T>;
+    execute: (data?: Record<string, unknown> | FormData, opts?: RequestOptions) => TreesPromise<T>;
 }
 /**
  * useBaseAPI is a composable wrapper of BaseAPI
@@ -63,13 +68,14 @@ export interface 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>;
+    status: Ref<number | undefined>;
+    error: ShallowRef<AxiosError<unknown, any> | Error | undefined>;
     isFinished: Ref<boolean>;
     isLoading: Ref<boolean>;
     isAborted: Ref<boolean>;
     hasFetched: Ref<boolean>;
     abort: () => void;
-    execute: (data?: Record<string, unknown> | FormData, opts?: RequestOptions) => Promise<T>;
+    execute: (data?: Record<string, unknown> | FormData, opts?: RequestOptions) => TreesPromise<T>;
 };
 /**
  * useBaseAPIGet is a convenience function for useBaseAPI

package/types/composables/usePopper.d.ts

@@ -0,0 +1,19 @@
+import { VNode } from "vue";
+import { Options, Placement } from "@popperjs/core";
+export declare type PopperPosition = Placement;
+export declare const offsetModifier: (skidding: number, distance: number) => {
+    options: {
+        offset: () => number[];
+    };
+    name: "offset";
+    enabled: boolean;
+    phase: import("@popperjs/core").ModifierPhases;
+    requires?: string[] | undefined;
+    requiresIfExists?: string[] | undefined;
+    fn: (arg0: import("@popperjs/core").ModifierArguments<import("@popperjs/core/lib/modifiers/offset").Options>) => void | import("@popperjs/core").State;
+    effect?: ((arg0: import("@popperjs/core").ModifierArguments<import("@popperjs/core/lib/modifiers/offset").Options>) => void | (() => void)) | undefined;
+    data?: import("@popperjs/core").Obj | undefined;
+};
+export declare function usePopper(opts: Partial<Options>): import("vue").Ref<VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}> | HTMLElement | undefined>[];

package/types/entry.d.ts

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

package/types/types/lists.d.ts

@@ -0,0 +1,12 @@
+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>;
+}