@data-fair/lib-vue 1.12.0 → 1.13.1

package/async-action.d.ts

@@ -0,0 +1,14 @@
+import { type Ref } from 'vue';
+import { type PartialUiNotif, type UiNotif } from './ui-notif.js';
+type AsyncActionOptions = {
+    error?: string;
+    success?: PartialUiNotif;
+    catch?: 'error' | 'success' | 'all';
+};
+export declare function asyncAction<F extends (...args: any[]) => Promise<any>>(fn: F, options?: AsyncActionOptions): {
+    execute: F;
+    notif: Ref<UiNotif | null>;
+    loading: Ref<boolean>;
+    error: Ref<string | null>;
+};
+export {};

package/async-action.js

@@ -0,0 +1,35 @@
+// similar to withUiNotif but more powerful
+import { ref } from 'vue'
+import { useUiNotif, getFullNotif, getErrorMsg } from './ui-notif.js'
+export function asyncAction (fn, options) {
+  const { sendUiNotif } = useUiNotif()
+  const notif = ref(null)
+  const loading = ref(false)
+  const error = ref(null)
+  const execute = async function (...args) {
+    loading.value = true
+    notif.value = null
+    error.value = null
+    try {
+      const result = await fn(...args)
+      if (options?.success) {
+        const successNotif = getFullNotif(options?.success, 'success')
+        notif.value = successNotif
+        if (options?.catch !== 'success' && options?.catch !== 'all') {
+          sendUiNotif(successNotif)
+        }
+      }
+      return result
+    } catch (err) {
+      const errorMsg = getErrorMsg(err)
+      error.value = errorMsg
+      const errorNotif = getFullNotif({ msg: options?.error ?? '', error: errorMsg })
+      notif.value = errorNotif
+      if (options?.catch !== 'error' && options?.catch !== 'all') {
+        sendUiNotif(errorNotif)
+      }
+    }
+    loading.value = false
+  }
+  return { execute, notif, loading, error }
+}

package/package.json

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

package/ui-notif.d.ts

@@ -17,6 +17,8 @@ interface UiNotifError {
     error: any;
     errorMsg: string;
 }
+export declare function getErrorMsg(error: any): string;
+export declare function getFullNotif(notif: PartialUiNotif, defaultType?: UiNotifBase['type']): UiNotif;
 export declare const getUiNotif: () => {
     notification: import("vue").Ref<{
         type?: ("default" | "info" | "success" | "warning") | undefined;

package/ui-notif.js

@@ -3,16 +3,16 @@
 // or can be displayed locally by @data-fair/lib-vuetify/ui-notif.vue
 import { ref, inject } from 'vue'
 import inIframe from '@data-fair/lib-utils/in-iframe.js'
-function getErrorMsg (error) {
+export function getErrorMsg (error) {
   if (typeof error === 'string') { return error }
   if (error.data && typeof error.data === 'string') { return error.data }
   if (error.response?.data && typeof error.response.data === 'string') { return error.response.data }
   if (typeof error.statusText === 'string') { return error.statusText }
   if (typeof error.response?.statusText === 'string') { return error.response?.statusText }
   if (error.message) { return error.message }
-  return 'erreur inconnu'
+  return 'erreur inconnue'
 }
-function getFullNotif (notif, defaultType = 'default') {
+export function getFullNotif (notif, defaultType = 'default') {
   if (typeof notif === 'string') { return { msg: notif, type: defaultType } }
   if (notif.error) {
     return {

package/vite.d.ts

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

package/vite.js

@@ -11,5 +11,6 @@ export const autoImports = [
     '@data-fair/lib-vue/ui-notif.js': ['useUiNotif', 'withUiNotif'],
     '@data-fair/lib-vue/fetch.js': ['useFetch'],
     '@data-fair/lib-vue/ws.js': ['useWS'],
+    '@data-fair/lib-vue/async-action.js': ['asyncAction'],
   }
 ]