bt-core-app 2.1.37 → 2.2.0

package/dist/composables/api.d.ts

@@ -0,0 +1,100 @@
+import { BTDemo } from './demo.ts';
+import { BTAuth } from './auth.ts';
+
+export interface QueryParams extends Record<string, any> {
+    filterBy?: string;
+    includeCount?: boolean;
+    includeInactive?: boolean;
+    lastUpdate?: string;
+    other?: any;
+    properties?: string[] | string;
+    query?: string;
+    searchString?: string;
+    sortOrder?: string;
+    sortBy?: string;
+    takeFrom?: number;
+    takeAmount?: number;
+}
+export interface PathOptions {
+    /**always added to end before query {url}/{additionalUrl}?{query} */
+    additionalUrl?: string;
+    /**application/json or other options */
+    contentType?: string;
+    /**that data to send in the body for POST, PATCH, and DELETE requests */
+    data?: any;
+    /** resulting url after building {nav | url}/{additionalUrl}?{params} */
+    finalUrl?: string;
+    /**override default headers */
+    headers?: HeadersInit;
+    /**id will be added as a url paramter (/{id}?) rather than as a query parameter */
+    id?: string;
+    /**where to find the url */
+    nav?: string;
+    /**headers will not be calculated.  Only the given headers in these options will be used */
+    overrideHeaders?: boolean;
+    /**query parameters */
+    params?: QueryParams;
+    /**attaches a proxyID to the request */
+    proxyID?: string;
+    /**whether to refresh the store data and go straight to the server */
+    refresh?: boolean;
+    /**returns result as a json object.  Defaults to true. */
+    returnJson?: boolean;
+    /**returns result as a string */
+    returnText?: boolean;
+    /**If false, returns response no matter the status code */
+    throwError?: boolean;
+    /**if exists then overrides default nav */
+    url?: string;
+    /**whether to preference using the local cache */
+    useLocalCache?: boolean;
+}
+export interface RequestPathOptions extends PathOptions {
+    method: string;
+}
+type FindPath = (navName?: string) => string | undefined;
+export interface CreateApiOptions {
+    auth?: BTAuth;
+    /**overrides the default */
+    buildHeaders?: (path: PathOptions, createOptions?: CreateApiOptions) => HeadersInit;
+    /**build a query.  Overrides the default */
+    buildQuery?: (params: any) => string;
+    /**overrides the default */
+    buildUrl?: (path: PathOptions) => string;
+    /**defaults to 'application/json' */
+    defaultContentType?: string;
+    /**returns result as a json object.  Defaults to true. */
+    defaultReturnJson?: boolean;
+    /**returns result as a string */
+    defaultReturnText?: boolean;
+    /**defaults to true.  Will throw an error on fail */
+    defaultThrowError?: boolean;
+    /**demo for providing any demo data */
+    demo?: BTDemo;
+    /**defaults to a function that returns '' */
+    findPath?: FindPath;
+    testUnauthorizedErrors?: boolean;
+    /**if true and logged in then will set an authorization header with 'bearer [token]' */
+    useBearerToken?: boolean;
+}
+export interface BTApi {
+    buildHeaders: (options: PathOptions, createOptions?: CreateApiOptions) => HeadersInit;
+    buildQuery: (params: any) => string;
+    buildUrl: (path: PathOptions) => string;
+    deleteItem: <T>(pathOptions: PathOptions) => Promise<T | undefined>;
+    get: <T>(pathOptions: PathOptions) => Promise<T | undefined>;
+    getAll: <T>(pathOptions: PathOptions) => Promise<T | undefined>;
+    getBlob: (pathOptions: PathOptions) => Promise<Response>;
+    post: <T>(pathOptions: PathOptions) => Promise<T | undefined>;
+    patch: <T>(pathOptions: PathOptions) => Promise<T | undefined>;
+    request: (pathOptions: RequestPathOptions) => Promise<Response | undefined>;
+    uploadImage: <T>(pathOptions: PathOptions) => Promise<T | undefined>;
+}
+export declare function useApi(): BTApi;
+export interface ApiError {
+    name: string;
+    code: 401 | 403;
+    message: string;
+}
+export declare function createApi(options?: CreateApiOptions): BTApi;
+export {};

package/dist/composables/api.mjs

@@ -0,0 +1,329 @@
+import { toValue as x } from "vue";
+import { appendUrl as $, DataURIToBlob as H } from "./helpers.mjs";
+let y;
+function C() {
+  return y;
+}
+function I(e) {
+  const m = (e == null ? void 0 : e.buildHeaders) ?? n, v = (e == null ? void 0 : e.buildQuery) ?? U, E = (e == null ? void 0 : e.buildUrl) ?? k, f = e == null ? void 0 : e.demo;
+  function U(r) {
+    let t = new URLSearchParams();
+    return Object.entries(r).forEach((l) => {
+      l[1] != null && t.append(l[0], l[1]);
+    }), r.filterBy && t.set("filterBy", r.filterBy), r.includeCount && t.set("includeCount", r.includeCount.toString()), r.includeInactive && t.set("includeInactive", r.includeInactive.toString()), r.properties && t.set("properties", r.properties.toString()), r.query && t.set("query", r.query.toString()), r.searchString && t.set("searchString", r.searchString), r.sortOrder && t.set("sortOrder", r.sortOrder), r.sortBy && t.set("sortBy", r.sortBy), r.takeFrom && t.set("takeFrom", r.takeFrom.toString()), r.takeAmount && t.set("takeAmount", r.takeAmount.toString()), r.other && Object.entries(r.other).forEach((l) => {
+      l[1] != null && t.append(l[0], l[1].toString());
+    }), t.toString();
+  }
+  function k(r) {
+    let t = x(r.url) ?? void 0, l = x(r.id);
+    return t == null && (e == null ? void 0 : e.findPath) != null && (t = e.findPath(r.nav)), r.additionalUrl != null && (t == null ? t = r.additionalUrl : t = $(t, r.additionalUrl)), l != null && (t != null && t.includes("{id}") ? t = t.replaceAll("{id}", l) : t = $(t, l)), r.params != null && (t = `${t}?${v(r.params)}`), r.finalUrl = t, r.finalUrl ?? "";
+  }
+  function n(r, t) {
+    var g, a;
+    let l = { ...r.headers };
+    return r.proxyID && (l.ManagedCompanyAccountID ?? (l.ManagedCompanyAccountID = r.proxyID)), (t == null ? void 0 : t.useBearerToken) != !1 && ((g = t == null ? void 0 : t.auth) == null ? void 0 : g.isLoggedIn.value) == !0 && (l.authorization ?? (l.authorization = `bearer ${(a = t == null ? void 0 : t.auth) == null ? void 0 : a.credentials.value.token}`)), l["Content-Type"] ?? (l["Content-Type"] = r.contentType ?? (t == null ? void 0 : t.defaultContentType) ?? "application/json"), l;
+  }
+  async function D(r) {
+    var g;
+    let t = r.finalUrl, l = r.headers;
+    return t == null && (t = E(r)), f != null && f.isDemoing.value ? (console.log(`DEMO: Get from ${t}`), f.get(r)) : (console.log(`Get from ${t}`), await ((g = e == null ? void 0 : e.auth) == null ? void 0 : g.tryRefreshToken()), r.overrideHeaders !== !0 && (l = m(r, e)), fetch(t, {
+      method: "GET",
+      mode: "cors",
+      cache: "no-cache",
+      headers: l
+    }));
+  }
+  async function R(r) {
+    var h, w;
+    const t = r.throwError ?? (e == null ? void 0 : e.defaultThrowError) ?? !0, l = r.returnJson ?? (e == null ? void 0 : e.defaultReturnJson) ?? !0, g = r.returnText ?? (e == null ? void 0 : e.defaultReturnText) ?? !1;
+    let a = r.finalUrl, c = r.headers;
+    a == null && (a = E(r));
+    let u;
+    try {
+      if (f != null && f.isDemoing.value)
+        return console.log(`DEMO: Get from ${a}`), f.get(r);
+      if (console.log(`Get from ${a}`), await ((h = e == null ? void 0 : e.auth) == null ? void 0 : h.tryRefreshToken()), r.overrideHeaders !== !0 && (c = m(r, e)), u = await fetch(a, {
+        method: "GET",
+        mode: "cors",
+        cache: "no-cache",
+        headers: c
+      }), !u.ok) {
+        if (u.status == 401)
+          throw e != null && e.testUnauthorizedErrors && await ((w = e == null ? void 0 : e.auth) == null ? void 0 : w.testToken()), {
+            code: u.status,
+            name: "Unauthorized",
+            message: u.statusText
+          };
+        let d = await u.text();
+        throw {
+          code: u.status,
+          name: "Get error",
+          message: d ?? u.statusText ?? ""
+        };
+      }
+      if (g)
+        return await u.text();
+      if (l)
+        return await u.json();
+      throw new Error();
+    } catch (d) {
+      const T = `${(u == null ? void 0 : u.status) ?? ""} ${(u == null ? void 0 : u.statusText) ?? ""} ${d.message}`;
+      if (!t)
+        return;
+      throw d.code == 401 ? d : {
+        code: (u == null ? void 0 : u.status) ?? (d == null ? void 0 : d.code) ?? void 0,
+        name: "Error",
+        message: T
+      };
+    }
+  }
+  async function J(r) {
+    var h, w;
+    const t = r.throwError ?? (e == null ? void 0 : e.defaultThrowError) ?? !0, l = r.returnJson ?? (e == null ? void 0 : e.defaultReturnJson) ?? !0, g = r.returnText ?? (e == null ? void 0 : e.defaultReturnText) ?? !1;
+    let a = r.finalUrl, c = r.headers;
+    a == null && (a = E(r));
+    let u;
+    try {
+      if (f != null && f.isDemoing.value)
+        return console.log(`DEMO: Get all from ${a}`), f.getAll(r);
+      if (console.log(`Get all from ${a}`), await ((h = e == null ? void 0 : e.auth) == null ? void 0 : h.tryRefreshToken()), r.overrideHeaders !== !0 && (c = m(r, e)), u = await fetch(a, {
+        method: "GET",
+        mode: "cors",
+        cache: "no-cache",
+        headers: c
+      }), !u.ok) {
+        if (u.status == 401)
+          throw e != null && e.testUnauthorizedErrors && await ((w = e == null ? void 0 : e.auth) == null ? void 0 : w.testToken()), {
+            code: u.status,
+            name: "Unauthorized",
+            message: u.statusText
+          };
+        let d = await u.text();
+        throw {
+          code: u.status,
+          name: "Get all error",
+          message: d ?? u.statusText ?? ""
+        };
+      }
+      if (g)
+        return await u.text();
+      if (l)
+        return await u.json();
+      throw new Error();
+    } catch (d) {
+      const T = `${(u == null ? void 0 : u.status) ?? ""} ${(u == null ? void 0 : u.statusText) ?? ""} ${d.message}`;
+      if (!t)
+        return;
+      throw d.code == 401 ? d : {
+        code: (u == null ? void 0 : u.status) ?? (d == null ? void 0 : d.code) ?? void 0,
+        name: "Error",
+        message: T
+      };
+    }
+  }
+  async function S(r) {
+    var h, w;
+    const t = r.throwError ?? (e == null ? void 0 : e.defaultThrowError) ?? !0, l = r.returnJson ?? (e == null ? void 0 : e.defaultReturnJson) ?? !0, g = r.returnText ?? (e == null ? void 0 : e.defaultReturnText) ?? !1;
+    let a = r.finalUrl, c = r.headers;
+    a == null && (a = E(r));
+    let u;
+    try {
+      if (f != null && f.isDemoing.value)
+        return console.log(`DEMO: Post to ${a}`), f.post(r);
+      if (console.log(`Post to ${a}`), await ((h = e == null ? void 0 : e.auth) == null ? void 0 : h.tryRefreshToken()), r.overrideHeaders !== !0 && (c = m(r, e)), u = await fetch(a, {
+        method: "POST",
+        mode: "cors",
+        cache: "no-cache",
+        headers: c,
+        body: JSON.stringify(r.data)
+      }), !u.ok) {
+        if (u.status == 401)
+          throw e != null && e.testUnauthorizedErrors && await ((w = e == null ? void 0 : e.auth) == null ? void 0 : w.testToken()), {
+            code: u.status,
+            name: "Unauthorized",
+            message: u.statusText
+          };
+        let d = await u.text();
+        throw {
+          code: u.status,
+          name: "Post error",
+          message: d ?? u.statusText ?? ""
+        };
+      }
+      if (g)
+        return await u.text();
+      if (l)
+        return await u.json();
+      throw new Error();
+    } catch (d) {
+      if (u.status == 200 || !t)
+        return;
+      const T = `${(u == null ? void 0 : u.status) ?? ""} ${(u == null ? void 0 : u.statusText) ?? ""} ${d.message}`;
+      throw d.code == 401 ? d : {
+        code: (u == null ? void 0 : u.status) ?? (d == null ? void 0 : d.code) ?? void 0,
+        name: "Post error",
+        message: T
+      };
+    }
+  }
+  async function b(r) {
+    var h, w;
+    const t = r.throwError ?? (e == null ? void 0 : e.defaultThrowError) ?? !0, l = r.returnJson ?? (e == null ? void 0 : e.defaultReturnJson) ?? !0, g = r.returnText ?? (e == null ? void 0 : e.defaultReturnText) ?? !1;
+    let a = r.finalUrl, c = r.headers;
+    a == null && (a = E(r));
+    let u;
+    try {
+      if (f != null && f.isDemoing.value)
+        return console.log(`DEMO: Patch to ${a}`), f.patch(r);
+      if (console.log(`Patch to ${a}`), await ((h = e == null ? void 0 : e.auth) == null ? void 0 : h.tryRefreshToken()), r.overrideHeaders !== !0 && (c = m(r, e)), u = await fetch(a, {
+        method: "PATCH",
+        mode: "cors",
+        cache: "no-cache",
+        headers: c,
+        body: JSON.stringify(r.data)
+      }), !u.ok) {
+        if (u.status == 401)
+          throw e != null && e.testUnauthorizedErrors && await ((w = e == null ? void 0 : e.auth) == null ? void 0 : w.testToken()), {
+            code: u.status,
+            name: "Unauthorized",
+            message: u.statusText
+          };
+        let d = await u.text();
+        throw {
+          code: u.status,
+          name: "Patch error",
+          message: d ?? u.statusText ?? ""
+        };
+      }
+      if (g)
+        return await u.text();
+      if (l)
+        return await u.json();
+      throw new Error();
+    } catch (d) {
+      if (u.status == 200 || !t)
+        return;
+      const T = `${(u == null ? void 0 : u.status) ?? ""} ${(u == null ? void 0 : u.statusText) ?? ""} ${d.message}`;
+      throw d.code == 401 ? d : {
+        code: (u == null ? void 0 : u.status) ?? (d == null ? void 0 : d.code) ?? void 0,
+        name: "Error",
+        message: T
+      };
+    }
+  }
+  async function M(r) {
+    var c, u;
+    const t = r.throwError ?? (e == null ? void 0 : e.defaultThrowError) ?? !0;
+    let l = r.finalUrl, g = r.headers;
+    l == null && (l = E(r));
+    let a;
+    try {
+      if (f != null && f.isDemoing.value)
+        return console.log(`DEMO: Delete ${l}`), f.deleteItem(r);
+      if (console.log(`Delete to ${l}`), await ((c = e == null ? void 0 : e.auth) == null ? void 0 : c.tryRefreshToken()), r.overrideHeaders !== !0 && (g = m(r, e)), a = await fetch(l, {
+        method: "DELETE",
+        mode: "cors",
+        cache: "no-cache",
+        headers: g,
+        body: JSON.stringify(r.data)
+      }), !a.ok)
+        throw a.status == 401 ? (e != null && e.testUnauthorizedErrors && await ((u = e == null ? void 0 : e.auth) == null ? void 0 : u.testToken()), {
+          code: a.status,
+          name: "Unauthorized",
+          message: a.statusText
+        }) : {
+          code: a.status,
+          name: "Deletion Error",
+          message: a.statusText
+        };
+      return;
+    } catch (h) {
+      const w = `${(a == null ? void 0 : a.status) ?? ""} ${(a == null ? void 0 : a.statusText) ?? ""} ${h.message}`;
+      if (!t)
+        return;
+      throw h.code == 401 ? h : {
+        code: (a == null ? void 0 : a.status) ?? (h == null ? void 0 : h.code) ?? void 0,
+        name: "Error",
+        message: w
+      };
+    }
+  }
+  async function z(r) {
+    var h;
+    const t = r.throwError ?? (e == null ? void 0 : e.defaultThrowError) ?? !0, l = r.returnJson ?? (e == null ? void 0 : e.defaultReturnJson) ?? !0, g = r.returnText ?? (e == null ? void 0 : e.defaultReturnText) ?? !1;
+    let a = r.finalUrl, c = r.headers;
+    if (a == null && (a = E(r)), r.overrideHeaders !== !0 && (c = m(r, e)), f != null && f.isDemoing.value)
+      return console.log(`DEMO: Uploading image to ${a}`), f.post(r);
+    console.log(`Upload image to ${a}`);
+    let u;
+    try {
+      const w = new FormData();
+      let d = typeof r.data == "string" ? H(r.data) : r.data;
+      w.append("file", d);
+      const T = { ...c };
+      if (delete T["Content-Type"], c = new Headers(T), u = await fetch(a, {
+        method: "POST",
+        mode: "cors",
+        cache: "no-cache",
+        headers: c,
+        body: w
+      }), u.status == 401)
+        throw e != null && e.testUnauthorizedErrors && await ((h = e == null ? void 0 : e.auth) == null ? void 0 : h.testToken()), {
+          code: u.status,
+          name: "Unauthorized",
+          message: u.statusText
+        };
+      return g ? await u.text() : l ? await u.json() : void 0;
+    } catch (w) {
+      if (u.status == 200 || !t)
+        return;
+      const d = `${(u == null ? void 0 : u.status) ?? ""} ${(u == null ? void 0 : u.statusText) ?? ""} ${w.message}`;
+      throw w.code == 401 ? w : {
+        code: (u == null ? void 0 : u.status) ?? (w == null ? void 0 : w.code) ?? void 0,
+        name: "Upload error",
+        message: d
+      };
+    }
+  }
+  async function G(r) {
+    var a;
+    const t = r.throwError ?? (e == null ? void 0 : e.defaultThrowError) ?? !0;
+    let l = r.finalUrl, g = r.headers;
+    l == null && (l = E(r));
+    try {
+      return f != null && f.isDemoing.value ? (console.log(`DEMO: Get from ${l}`), f.get(r)) : (console.log(`Get from ${l}`), await ((a = e == null ? void 0 : e.auth) == null ? void 0 : a.tryRefreshToken()), r.overrideHeaders !== !0 && (g = m(r, e)), await fetch(l, {
+        method: r.method,
+        mode: "cors",
+        cache: "no-cache",
+        headers: g
+      }));
+    } catch (c) {
+      const u = `  ${c.message}`;
+      if (!t)
+        return;
+      throw c.code == 401 ? c : {
+        code: (c == null ? void 0 : c.code) ?? void 0,
+        name: "Error",
+        message: u
+      };
+    }
+  }
+  return y = {
+    buildHeaders: m,
+    buildQuery: v,
+    buildUrl: E,
+    deleteItem: M,
+    get: R,
+    getAll: J,
+    getBlob: D,
+    // getFetch,
+    patch: b,
+    post: S,
+    request: G,
+    uploadImage: z
+  }, y;
+}
+export {
+  I as createApi,
+  C as useApi
+};

package/dist/composables/assistant.d.ts

@@ -0,0 +1,38 @@
+import { Ref } from 'vue';
+
+export interface HelpLink {
+    categories?: string[];
+    description?: string;
+    icon?: string;
+    id: string;
+    isAlways?: boolean;
+    routeNames?: string[];
+    sort?: number;
+    subtitle?: string;
+    tags?: string[];
+    title?: string;
+    url?: string;
+}
+export interface CreateAssistantOptions {
+    firstFeedbackAfterDays?: number;
+    feedbackAfterDays?: number;
+    helpMenuRoute?: string;
+    hideFeedback?: boolean;
+    items: HelpLink[];
+    storageKey?: string;
+}
+export interface BTAssistant {
+    allItems: HelpLink[];
+    doShowDialog: (routeName?: string) => boolean;
+    getLinks: (routeName?: string, tags?: string[]) => HelpLink[];
+    getPrimaryLinks: (routeName?: string, tags?: string[]) => HelpLink[];
+    getSecondaryLinks: (routeName?: string, tags?: string[]) => HelpLink[];
+    hideDialogPermanently: (rotueName?: string) => void;
+    hideDialogTemporarily: () => void;
+    hideFeedback: Ref<boolean>;
+    menuRouteName?: string;
+    tab: Ref<number>;
+}
+export declare function useAssistant(): BTAssistant;
+export declare function createAssistant(options?: CreateAssistantOptions): BTAssistant;
+export declare function findYouTubeAvatar(url?: string): string | undefined;

package/dist/composables/assistant.mjs

@@ -0,0 +1,70 @@
+import { useStorage as T } from "@vueuse/core";
+import i from "../bt-core/core/node_modules/luxon/src/datetime.mjs";
+import "../bt-core/core/node_modules/luxon/src/duration.mjs";
+import { ref as d } from "vue";
+let n;
+function F() {
+  return n;
+}
+function L(e) {
+  if (n != null)
+    return n;
+  e ?? (e = {
+    items: []
+  });
+  const r = T(e.storageKey ?? "assistant_dialog", {
+    feedbackTill: void 0,
+    hideTill: void 0,
+    items: {}
+  }), m = d(), s = d((e == null ? void 0 : e.hideFeedback) == !0), c = d(0);
+  function v(u, f) {
+    return (e == null ? void 0 : e.items.filter((l) => !!(l.isAlways == !0 || l.routeNames != null && u != null && l.routeNames.some((a) => a == u) || l.tags != null && f != null && l.tags.some((a) => f.some((t) => a == t))))) ?? [];
+  }
+  function b(u, f) {
+    return (e == null ? void 0 : e.items.filter((l) => !!(l.routeNames != null && u != null && l.routeNames.some((a) => a == u) || l.tags != null && f != null && l.tags.some((a) => f.some((t) => a == t))))) ?? [];
+  }
+  function k(u, f) {
+    return (e == null ? void 0 : e.items.filter((l) => !(l.isAlways != !0 || l.routeNames != null && u != null && l.routeNames.some((a) => a == u) || l.tags != null && f != null && l.tags.some((a) => f.some((t) => a == t))))) ?? [];
+  }
+  function g(u) {
+    u != null && (r.value.items[u] = !0);
+  }
+  function y() {
+    m.value == "feedback" && (e == null ? void 0 : e.feedbackAfterDays) != null ? r.value.feedbackTill = i.now().plus({ days: e.feedbackAfterDays }).toString() : r.value.hideTill = i.now().plus({ days: 3 }).toString();
+  }
+  function h(u) {
+    if (m.value = void 0, u == null)
+      return !1;
+    const f = i.now().toString();
+    if (((e == null ? void 0 : e.firstFeedbackAfterDays) != null || (e == null ? void 0 : e.feedbackAfterDays) != null) && (r.value.feedbackTill == null && (r.value.feedbackTill = i.now().plus({ days: (e == null ? void 0 : e.firstFeedbackAfterDays) ?? (e == null ? void 0 : e.feedbackAfterDays) }).toString()), r.value.feedbackTill < f))
+      return c.value = 1, m.value = "feedback", e.feedbackAfterDays != null && (r.value.feedbackTill = i.now().plus({ days: e.feedbackAfterDays }).toString()), !0;
+    if (r.value.hideTill != null && r.value.hideTill > f)
+      return !1;
+    var l = r.value.items[u] != !0 && e.items.some((a) => !!(a.routeNames != null && a.routeNames.some((t) => t == u)));
+    return l ? (c.value = 0, m.value = "help", !0) : !1;
+  }
+  return n = {
+    allItems: e.items ?? [],
+    doShowDialog: h,
+    getLinks: v,
+    getPrimaryLinks: b,
+    getSecondaryLinks: k,
+    hideFeedback: s,
+    menuRouteName: e.helpMenuRoute,
+    hideDialogPermanently: g,
+    hideDialogTemporarily: y,
+    tab: c
+  }, n;
+}
+function N(e) {
+  if (e != null) {
+    var r = e.split("?v=");
+    if (!(r.length < 2) && (r = r[1].split("&"), r[0] != null))
+      return `http://img.youtube.com/vi/${r[0]}/0.jpg`;
+  }
+}
+export {
+  L as createAssistant,
+  N as findYouTubeAvatar,
+  F as useAssistant
+};

package/dist/composables/auth.d.ts

@@ -0,0 +1,94 @@
+import { PermissionGroup } from './navigation.ts';
+import { Ref, ComputedRef } from 'vue';
+import { Router } from 'vue-router';
+import { BTCreateMenu } from '../composables/menu.ts';
+import { RemovableRef } from '@vueuse/core';
+
+export interface AuthItem {
+    children?: AuthItem[];
+    ignoreSuspension?: boolean;
+    permissions?: PermissionGroup | PermissionGroup[];
+    requiresAuth?: boolean;
+    subscriptions?: string[];
+}
+export interface AuthSubscription {
+    code: string;
+    value: number;
+}
+export interface BaseAuthCredentials {
+    expiresOn?: string;
+    isGlobalAdmin?: boolean;
+    isLoggedIn?: boolean;
+    isSuspended?: boolean;
+    permissions?: string;
+    refreshExpiresOn?: string;
+    refreshToken?: string;
+    subscriptionCode?: string;
+    timeZone?: string;
+    token?: string;
+    userID?: string;
+    userPermissions?: string[];
+}
+export interface CreateAuthOptions {
+    defaultTimeZone?: string;
+    /**expiry token date format.  Defaults to 'd/MM/yyyy h:mm:ss a' */
+    expiryTokenFormat?: string;
+    /**OVERRIDES CORE DEFAULT. retrieve the auth item */
+    getAuthItem?: (navName?: string | AuthItem) => AuthItem | null;
+    /**OVERRIDES DEFAULT. the url to start the OAuth 2.0 process */
+    getAuthorizeUrl?: (redirectPath?: string, state?: string) => string;
+    /**OVERRIDES DEFAULT. use the given code and generate the url to convert to an access token */
+    getTokenUrl?: (code: string, redirect_uri: string, grant_type: string, client_id: string) => string;
+    /**OVERRIDES DEFAULT.  */
+    getToken?: (code?: string, state?: string) => Promise<void>;
+    getTokenTestUrl?: (token: string) => string;
+    menu?: BTCreateMenu;
+    oauthGrantType?: string;
+    oauthClientID?: string;
+    /**sets current credentials on top of default function
+     * for processing the token payload and applying to state
+    */
+    processTokenPayload?: (state: RemovableRef<any>, payload: any) => void;
+    router?: Router;
+    /**suboptions */
+    subscriptionOptions?: AuthSubscription[];
+    /**tests whether token is still valid after receiving a 401 Unauthorized Response */
+    testToken?: (code?: string) => Promise<boolean>;
+    /**where to route to if token is no longer valid */
+    tokenInvalidPath?: string;
+    /**overrides refresh token and all params below */
+    tryRefreshToken?: (authObj?: any) => Promise<void>;
+    /**how many minutes left on refresh expiry before refreshing | Defaults to 10,800 (7 days) */
+    tokenRefreshMinuteWindow?: number;
+    /**if UseTokenRefresh */
+    tokenRefreshPath?: string;
+    /**whether to use token refreshing */
+    useTokenRefresh?: boolean;
+}
+export interface BTAuth {
+    authState: Ref<string>;
+    /**Global Admin, everything.edit, *.edit */
+    canEdit: (navName?: string) => boolean;
+    canEditPermit: (permit: string) => boolean;
+    /**Global Admin, everything.view, *.view */
+    canView: (navName?: string) => boolean;
+    canViewPermit: (permit: string) => boolean;
+    credentials: RemovableRef<any>;
+    doShow: (subcodes?: string[], permissions?: PermissionGroup | PermissionGroup[], action?: 'view' | 'edit') => boolean;
+    doShowByNav: (navName?: string | AuthItem, includeChildren?: boolean) => boolean;
+    getAuthorizeUrl: (redirectPath?: string) => string;
+    getToken: (code?: string, state?: string) => Promise<void>;
+    isLoggedIn: ComputedRef<boolean>;
+    login: (redirectPath?: string, query?: any) => void;
+    logout: (navNameRedirect?: string) => void;
+    refreshTokenExpired: () => boolean;
+    resetAuthState: () => void;
+    setAuth: (jwtToken?: string) => void;
+    testToken: () => Promise<boolean>;
+    timeZone: ComputedRef<string>;
+    tokenExpired: () => boolean;
+    tryLogin: (redirectPath?: string, query?: any) => boolean | undefined;
+    tryRefreshToken: () => Promise<void>;
+}
+export declare function useAuth(): BTAuth;
+export declare function createAuth(options: CreateAuthOptions): BTAuth;