@xy-planning-network/trees 0.4.8 → 0.4.9-rc-1

package/package.json

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

package/types/api/base.d.ts

@@ -1,6 +1,6 @@
 import { AxiosRequestConfig } from "axios";
 export declare type RequestMethod = "GET" | "get" | "PUT" | "put" | "POST" | "post" | "DELETE" | "delete";
-export interface RequestOptions extends AxiosRequestConfig {
+export interface RequestOptions {
     /**
      * returns the nested data key inside the AxiosResponse data when true
      */
@@ -15,10 +15,10 @@ export interface RequestOptions extends AxiosRequestConfig {
     withDelay?: number;
 }
 declare const BaseAPI: {
-    makeRequest<T = any>(opts: RequestOptions): Promise<T>;
+    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>, opts: RequestOptions): Promise<T_3>;
-    put<T_4 = any>(path: string, data: Record<string, unknown>, opts: RequestOptions): Promise<T_4>;
+    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>;
 };
 export default BaseAPI;

package/types/composables/useBaseAPI.d.ts

@@ -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) => Promise<T>;
+    execute: (data?: Record<string, unknown> | FormData, opts?: RequestOptions) => Promise<T>;
 }
 /**
  * useBaseAPI is a composable wrapper of BaseAPI
@@ -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>, opts?: RequestOptions) => Promise<T>;
+    execute: (data?: Record<string, unknown> | FormData, opts?: RequestOptions) => Promise<T>;
 };
 /**
  * useBaseAPIGet is a convenience function for useBaseAPI

package/types/composables/useFlashes.d.ts

@@ -0,0 +1,100 @@
+import { Ref } from "vue";
+/**
+ * FlashMessage represents the shape of an on screen notification
+ * to a user.
+ */
+export interface FlashMessage {
+    /**
+     * The primary body text of the flash.  It supports HTML.
+     */
+    message: string;
+    /**
+     * Allow the flash to stay on the screen until the user removes it.
+     */
+    persistent?: boolean;
+    /**
+     * Determines the style of the flash.
+     */
+    type: FlashType;
+}
+/**
+ * FlashType is used to set the style of the flash that is displayed.
+ */
+export declare type FlashType = "warning" | "error" | "info" | "success";
+/**
+ * The FlasherAPI offers a simple set of methods for adding and removing flash messages.
+ * The implementor of the FlasherAPI is responsible for determining where flashes are stored.
+ */
+export interface FlasherAPI {
+    add(flash: FlashMessage): string;
+    remove(id: string): void;
+    error(msg: string, persistent?: boolean): string;
+    info(msg: string, persistent?: boolean): string;
+    success(msg: string, persistent?: boolean): string;
+    warning(msg: string, persistent?: boolean): string;
+    genericError(email?: string, persistent?: boolean): string;
+    setConfig(config: FlasherConfig): void;
+}
+/**
+ * A storage type for flash management.
+ */
+declare type FlashStore = Map<string, FlashMessage>;
+/**
+ *
+ */
+interface FlasherConfig {
+    removeDelay?: number;
+    email?: string;
+}
+/**
+ * newFlasher implements the FlasherAPI interface on the FlashStore it recieves
+ * the flash remove delay and a default email address for generic flashes is configurable
+ */
+export declare const newFlasher: (flashStore: FlashStore, flasherConfig?: FlasherConfig | undefined) => {
+    add(flash: FlashMessage): string;
+    remove(id: string): void;
+    flash(flash: FlashMessage): string;
+    error(message: string, persistent?: boolean): string;
+    info(message: string, persistent?: boolean): string;
+    success(message: string, persistent?: boolean): string;
+    warning(message: string, persistent?: boolean): string;
+    genericError(email?: string, persistent?: boolean): string;
+    setConfig: (newConfig: FlasherConfig) => void;
+};
+declare const flasher: {
+    add(flash: FlashMessage): string;
+    remove(id: string): void;
+    flash(flash: FlashMessage): string;
+    error(message: string, persistent?: boolean): string;
+    info(message: string, persistent?: boolean): string;
+    success(message: string, persistent?: boolean): string;
+    warning(message: string, persistent?: boolean): string;
+    genericError(email?: string, persistent?: boolean): string;
+    setConfig: (newConfig: FlasherConfig) => void;
+};
+export default flasher;
+/**
+ * useFlashes exposes the module level global flashes and flasher for shared access to
+ * the a flash queue when a flashStore isn't provided
+ * @returns UseFlashes
+ */
+export declare function useFlashes(flashStore?: Ref<FlashStore>): {
+    flasher: {
+        add(flash: FlashMessage): string;
+        remove(id: string): void;
+        flash(flash: FlashMessage): string;
+        error(message: string, persistent?: boolean): string;
+        info(message: string, persistent?: boolean): string;
+        success(message: string, persistent?: boolean): string;
+        warning(message: string, persistent?: boolean): string;
+        genericError(email?: string, persistent?: boolean): string;
+        setConfig: (newConfig: FlasherConfig) => void;
+    };
+    flashes: Ref<Map<string, FlashMessage>>;
+};
+/**
+ * A helper method to load any flashes on the global Window.Flashes into the flashes ref.
+ * The flasher argument ultimately determines what flashes ref they should be added to.
+ * @param flasher FlashAPI
+ */
+export declare const loadWindowFlashes: (flasher: FlasherAPI) => void;

package/types/lib-components/forms/RadioCards.vue.d.ts

@@ -0,0 +1,55 @@
+declare type ModelValue = string | number;
+declare type RadioCard = {
+    disabled?: boolean;
+    help?: string;
+    label: string;
+    sublabel?: string;
+    value: ModelValue;
+};
+declare const _default: import("vue").DefineComponent<{
+    columns: {
+        type: import("vue").PropType<2 | 3>;
+    } & {
+        default: undefined;
+    };
+    help: {
+        type: import("vue").PropType<string>;
+    } & {
+        default: string;
+    };
+    legend: {
+        type: import("vue").PropType<string>;
+    } & {
+        default: string;
+    };
+    modelValue: {
+        type: import("vue").PropType<ModelValue>;
+        required: true;
+    };
+    options: {
+        type: import("vue").PropType<RadioCard[]>;
+        required: true;
+    };
+}, () => void, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (modelValue: ModelValue) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
+    columns?: unknown;
+    help?: unknown;
+    legend?: unknown;
+    modelValue?: unknown;
+    options?: unknown;
+} & {
+    modelValue: ModelValue;
+    help: string;
+    options: RadioCard[];
+    legend: string;
+} & {
+    columns?: 2 | 3 | undefined;
+}> & {
+    "onUpdate:modelValue"?: ((modelValue: ModelValue) => any) | undefined;
+}, {
+    help: string;
+    legend: string;
+    columns: 2 | 3;
+}>;
+export default _default;

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>;
+}