@data-fair/lib-vue 1.1.1 → 1.2.0

package/fetch.d.ts

@@ -0,0 +1,11 @@
+import type { QueryObject } from 'ufo';
+import type { Ref } from 'vue';
+type UseFetchOptions = {
+    query?: QueryObject | Ref<QueryObject>;
+};
+export declare function useFetch<T>(url: string | Ref<string>, options?: UseFetchOptions): {
+    data: [T | null] extends [Ref<any, any>] ? import("@vue/shared").IfAny<Ref<any, any> & T, Ref<Ref<any, any> & T, Ref<any, any> & T>, Ref<any, any> & T> : Ref<import("vue").UnwrapRef<T> | null, T | import("vue").UnwrapRef<T> | null>;
+    loading: Ref<boolean, boolean>;
+    refresh: () => Promise<void>;
+};
+export default useFetch;

package/fetch.js

@@ -0,0 +1,27 @@
+import { ofetch } from 'ofetch'
+import { withQuery } from 'ufo'
+import { computed, isRef, watch, ref } from 'vue'
+import { useUiNotif } from '@data-fair/lib-vue/ui-notif.js'
+export function useFetch (url, options = {}) {
+  const { sendUiNotif } = useUiNotif()
+  const fullUrl = computed(() => {
+    let fullUrl = isRef(url) ? url.value : url
+    const query = isRef(options.query) ? options.query.value : options.query
+    if (query) { fullUrl = withQuery(fullUrl, query) }
+    return fullUrl
+  })
+  const data = ref(null)
+  const loading = ref(false)
+  const refresh = async () => {
+    loading.value = true
+    try {
+      data.value = await ofetch(fullUrl.value)
+    } catch (error) {
+      sendUiNotif({ msg: '', error })
+    }
+    loading.value = false
+  }
+  watch(fullUrl, refresh, { immediate: true })
+  return { data, loading, refresh }
+}
+export default useFetch

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@data-fair/lib-vue",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Composables and other utilities for Vue applications in the data-fair stack.",
   "main": "index.js",
   "files": [

package/ui-notif.d.ts

@@ -36,7 +36,6 @@ export declare const getUiNotif: () => {
         errorMsg: string;
     } | null>;
     sendUiNotif: (partialNotif: PartialUiNotif) => void;
-    withUiNotif: <F extends (...args: any[]) => Promise<any>>(fn: F, errorMsg: string, successNotif?: PartialUiNotif) => F;
 };
 export declare const uiNotifKey: unique symbol;
 export declare function createUiNotif(): {
@@ -44,3 +43,4 @@ export declare function createUiNotif(): {
 };
 export declare function useUiNotif(): ReturnType<typeof getUiNotif>;
 export default useUiNotif;
+export declare function withUiNotif<F extends (...args: any[]) => Promise<any>>(fn: F, errorMsg?: string, successNotif?: PartialUiNotif): F;

package/ui-notif.js

@@ -15,7 +15,6 @@ function getErrorMsg (error) {
 function getFullNotif (notif, defaultType = 'default') {
   if (typeof notif === 'string') { return { msg: notif, type: defaultType } }
   if (notif.error) {
-    console.log('ERROR', notif.error)
     return {
       ...notif,
       type: 'error',
@@ -29,7 +28,7 @@ function getFullNotif (notif, defaultType = 'default') {
 }
 export const getUiNotif = () => {
   const notification = ref(null)
-  const sendUiNotif = (partialNotif) => {
+  function sendUiNotif (partialNotif) {
     const notif = notification.value = getFullNotif(partialNotif)
     if (inIframe) {
       window.top?.postMessage({ vIframe: true, uiNotification: notif }, '*')
@@ -37,18 +36,7 @@ export const getUiNotif = () => {
       console.log('iframe notification', notif)
     }
   }
-  function withUiNotif (fn, errorMsg, successNotif) {
-    return async function (...args) {
-      try {
-        const result = await fn(...args)
-        if (successNotif) { sendUiNotif(getFullNotif(successNotif, 'success')) }
-        return result
-      } catch (error) {
-        sendUiNotif({ msg: errorMsg, error })
-      }
-    }
-  }
-  return { notification, sendUiNotif, withUiNotif }
+  return { notification, sendUiNotif }
 }
 // uses pattern for SSR friendly plugin/composable, cf https://antfu.me/posts/composable-vue-vueday-2021#shared-state-ssr-friendly
 export const uiNotifKey = Symbol('uiNotif')
@@ -62,3 +50,15 @@ export function useUiNotif () {
   return uiNotif
 }
 export default useUiNotif
+export function withUiNotif (fn, errorMsg, successNotif) {
+  const { sendUiNotif } = useUiNotif()
+  return async function (...args) {
+    try {
+      const result = await fn(...args)
+      if (successNotif) { sendUiNotif(getFullNotif(successNotif, 'success')) }
+      return result
+    } catch (error) {
+      sendUiNotif({ msg: errorMsg ?? '', error })
+    }
+  }
+}

package/vite.d.ts

@@ -4,4 +4,6 @@ export declare const autoImports: (string | {
     '@data-fair/lib-vue/locale-dayjs.js': string[];
     '@data-fair/lib-vue/concept-filters.js': string[];
     '@data-fair/lib-vue/ui-notif.js': string[];
+    '@data-fair/lib-vue/fetch.js': string[];
+    '@data-fair/lib-vue/ws.js': string[];
 })[];

package/vite.js

@@ -4,10 +4,12 @@ export const autoImports = [
   'vue-i18n',
   'vue-router',
   {
-    '@data-fair/lib-vue/session.js': ['useSession'],
-    '@data-fair/lib-vue/reactive-search-params.js': ['useReactiveSearchParams'],
+    '@data-fair/lib-vue/session.js': ['useSession', 'useSessionAuthenticated'],
+    '@data-fair/lib-vue/reactive-search-params.js': ['useReactiveSearchParams', 'useStringSearchParam', 'useBooleanSearchParam', 'useNumberSearchParam', 'useStringsArraySearchParam'],
     '@data-fair/lib-vue/locale-dayjs.js': ['useLocaleDayjs'],
     '@data-fair/lib-vue/concept-filters.js': ['useConceptFilters'],
-    '@data-fair/lib-vue/ui-notif.js': ['useUiNotif']
+    '@data-fair/lib-vue/ui-notif.js': ['useUiNotif', 'withUiNotif'],
+    '@data-fair/lib-vue/fetch.js': ['useFetch'],
+    '@data-fair/lib-vue/ws.js': ['useWS'],
   }
 ]

package/ui-notif-global.d.ts

@@ -1,22 +0,0 @@
-declare const _default: {
-    notification: import("vue").Ref<{
-        type?: ("default" | "info" | "success" | "warning") | undefined;
-        msg: string;
-    } | {
-        type: "error";
-        msg: string;
-        error: any;
-        errorMsg: string;
-    } | null, import("./ui-notif.js").UiNotif | {
-        type?: ("default" | "info" | "success" | "warning") | undefined;
-        msg: string;
-    } | {
-        type: "error";
-        msg: string;
-        error: any;
-        errorMsg: string;
-    } | null>;
-    sendUiNotif: (partialNotif: import("./ui-notif.js").PartialUiNotif) => void;
-    withUiNotif: <F extends (...args: any[]) => Promise<any>>(fn: F, errorMsg: string, successNotif?: import("./ui-notif.js").PartialUiNotif) => F;
-};
-export default _default;