@data-fair/lib-vue 1.0.0 → 1.1.0

package/auto-imports.js

@@ -0,0 +1,13 @@
+// made for https://github.com/unplugin/unplugin-auto-import
+export default [
+  'vue',
+  'vue-i18n',
+  'vue-router',
+  {
+    '@data-fair/lib-vue/session.js': ['useSession'],
+    '@data-fair/lib-vue/reactive-search-params.js': ['useReactiveSearchParams'],
+    '@data-fair/lib-vue/locale-dayjs.js': ['useLocaleDayjs'],
+    '@data-fair/lib-vue/concept-filters.js': ['useConceptFilters'],
+    '@data-fair/lib-vue/ui-notif.js': ['useUiNotif']
+  }
+]

package/locale-dayjs-global.d.ts

@@ -1,4 +1,4 @@
-export declare const locale: import("vue").Ref<string, string>, dayjs: (date?: string | number | import("dayjs").Dayjs | Date | null | undefined) => import("dayjs").Dayjs & {
+export declare const locale: string, dayjs: (date?: string | number | import("dayjs").Dayjs | Date | null | undefined) => import("dayjs").Dayjs & {
     fromNow(withoutSuffix?: boolean): string;
     from(compared: import("dayjs").ConfigType, withoutSuffix?: boolean): string;
     toNow(withoutSuffix?: boolean): string;

package/locale-dayjs-global.js

@@ -4,4 +4,5 @@ import { getLocaleDayjs } from './locale-dayjs.js'
 if (import.meta.env?.SSR) {
   throw new Error('this module uses a module level singleton, it cannot be used in SSR mode')
 }
+console.error('locale-dayjs-global is deprecated, please use create + use')
 export const { locale, dayjs } = getLocaleDayjs()

package/locale-dayjs.d.ts

@@ -1,5 +1,5 @@
 import type { Dayjs, ConfigType } from 'dayjs';
-import type { Ref, App } from 'vue';
+import type { App } from 'vue';
 import dayjs from 'dayjs';
 import 'dayjs/locale/fr';
 import 'dayjs/locale/en';
@@ -9,12 +9,12 @@ type RelativeDayjs = Dayjs & {
     toNow(withoutSuffix?: boolean): string;
     to(compared: ConfigType, withoutSuffix?: boolean): string;
 };
-export declare function getLocaleDayjs(_locale?: Ref<string>): {
-    locale: Ref<string, string>;
+export declare function getLocaleDayjs(locale?: string): {
+    locale: string;
     dayjs: (date?: string | number | dayjs.Dayjs | Date | null | undefined) => RelativeDayjs;
 };
 export declare const localeDayjsKey: unique symbol;
-export declare function createLocaleDayjs(locale: Ref<string>): {
+export declare function createLocaleDayjs(locale?: string): {
     install(app: App): void;
 };
 export declare function useLocaleDayjs(): ReturnType<typeof getLocaleDayjs>;

package/locale-dayjs.js

@@ -1,4 +1,4 @@
-import { inject, ref } from 'vue'
+import { inject } from 'vue'
 import dayjs from 'dayjs'
 import 'dayjs/locale/fr'
 import 'dayjs/locale/en'
@@ -8,12 +8,12 @@ dayjs.extend(localizedFormat)
 dayjs.extend(relativeTime)
 // main functionality, use through the createLocaleDayjs plugin and useLocaleDayjs composable
 // or as a global singleton through ./locale-dayjs-global.js
-export function getLocaleDayjs (_locale) {
-  const locale = _locale ?? ref('fr')
+export function getLocaleDayjs (locale) {
+  locale = locale ?? 'fr'
   return {
     locale,
     dayjs: (date) => {
-      return dayjs(date).locale(locale.value)
+      return dayjs(date).locale(locale)
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@data-fair/lib-vue",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Composables and other utilities for Vue applications in the data-fair stack.",
   "main": "index.js",
   "files": [
@@ -10,7 +10,8 @@
   "author": "",
   "license": "MIT",
   "scripts": {
-    "prepublishOnly": "cd .. && npm run prepublishOnly"
+    "prepublishOnly": "cd .. && npm run prepublishOnly",
+    "build": "cd .. && npm run build"
   },
   "peerDependencies": {
     "dayjs": "1",

package/reactive-search-params.d.ts

@@ -4,7 +4,7 @@ export declare function getReactiveSearchParams(router?: Router): Record<string,
 export declare const reactiveSearchParamsKey: unique symbol;
 export declare function createReactiveSearchParams(router?: Router): {
     install(app: App): void;
-    value: Record<string, string>;
+    state: Record<string, string>;
 };
 export declare function useReactiveSearchParams(): ReturnType<typeof getReactiveSearchParams>;
 export declare const useStringSearchParam: (key: string, options?: string | {

package/reactive-search-params.js

@@ -82,7 +82,7 @@ export function createReactiveSearchParams (router) {
   const reactiveSearchParams = getReactiveSearchParams(router)
   return {
     install (app) { app.provide(reactiveSearchParamsKey, reactiveSearchParams) },
-    value: reactiveSearchParams
+    state: reactiveSearchParams
   }
 }
 export function useReactiveSearchParams () {

package/session.d.ts

@@ -3,15 +3,16 @@ import { type Ref, App } from 'vue';
 import { type RouteLocation } from 'vue-router';
 import { type fetch } from 'ofetch';
 import { type SessionState, type SessionStateAuthenticated } from '@data-fair/lib-common-types/session/index.js';
+export type { SessionState, SessionStateAuthenticated, User, Account } from '@data-fair/lib-common-types/session/index.js';
 interface GenericCookies {
     get: (key: string) => string | undefined;
     set: (key: string, value: string, options?: Record<string, any>) => void;
     remove: (key: string) => void;
 }
 export interface SessionOptions {
+    sitePath: string;
+    directoryUrl: string;
     route?: RouteLocation;
-    sitePath?: string;
-    directoryUrl?: string;
     logoutRedirectUrl?: string;
     req?: IncomingMessage;
     cookies?: GenericCookies;
@@ -35,11 +36,23 @@ export interface Session {
 export type SessionAuthenticated = Session & {
     state: SessionStateAuthenticated;
 };
-export declare function getSession(initOptions: SessionOptions): Promise<Session>;
+export declare function getSession(initOptions: Partial<SessionOptions>): Promise<Session>;
 export declare const sessionKey: unique symbol;
 export declare function createSession(initOptions: SessionOptions): Promise<{
     install(app: App): void;
-    value: Session;
+    state: SessionState;
+    loginUrl: (redirect?: string, extraParams?: Record<string, string>, immediateRedirect?: true) => string;
+    login: (redirect?: string, extraParams?: Record<string, string>, immediateRedirect?: true) => void;
+    logout: (redirect?: string) => Promise<void>;
+    switchOrganization: (org: string | null, dep?: string) => void;
+    setAdminMode: (adminMode: boolean, redirect?: string) => Promise<void>;
+    asAdmin: (user: any | null) => Promise<void>;
+    cancelDeletion: () => Promise<void>;
+    keepalive: () => Promise<void>;
+    switchDark: (value: boolean) => void;
+    switchLang: (value: string) => void;
+    topLocation: Ref<Location | undefined>;
+    options: SessionOptions;
 }>;
 export declare function useSession(): Session;
 export declare function useSessionAuthenticated(errorBuilder?: () => any): SessionAuthenticated;

package/session.js

@@ -238,8 +238,8 @@ export const sessionKey = Symbol('session')
 export async function createSession (initOptions) {
   const session = await getSession(initOptions)
   return {
+    ...session,
     install (app) { app.provide(sessionKey, session) },
-    value: session
   }
 }
 export function useSession () {

package/ui-notif-global.d.ts

@@ -1,5 +1,5 @@
 declare const _default: {
-    current: import("vue").Ref<{
+    notification: import("vue").Ref<{
         type?: ("default" | "info" | "success" | "warning") | undefined;
         msg: string;
     } | {
@@ -16,6 +16,7 @@ declare const _default: {
         error: any;
         errorMsg: string;
     } | null>;
-    send: (partialNotif: import("./ui-notif.js").PartialUiNotif) => void;
+    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;

package/ui-notif-global.js

@@ -4,4 +4,5 @@ import { getUiNotif } from './ui-notif.js'
 if (import.meta.env?.SSR) {
   throw new Error('this module uses a module level singleton, it cannot be used in SSR mode')
 }
+console.error('ui-notif-global is deprecated, please use create + use')
 export default getUiNotif()

package/ui-notif.d.ts

@@ -1,11 +1,12 @@
 import type { App } from 'vue';
 export type UiNotif = UiNotifBase | UiNotifError;
-export interface PartialUiNotif {
-    type?: 'default' | 'info' | 'success' | 'warning' | 'error';
+type NotifType = 'default' | 'info' | 'success' | 'warning' | 'error';
+export type PartialUiNotif = string | {
+    type?: NotifType;
     msg: string;
     error?: any;
     errorMsg?: string;
-}
+};
 interface UiNotifBase {
     type?: 'default' | 'info' | 'success' | 'warning';
     msg: string;
@@ -17,7 +18,7 @@ interface UiNotifError {
     errorMsg: string;
 }
 export declare const getUiNotif: () => {
-    current: import("vue").Ref<{
+    notification: import("vue").Ref<{
         type?: ("default" | "info" | "success" | "warning") | undefined;
         msg: string;
     } | {
@@ -34,7 +35,8 @@ export declare const getUiNotif: () => {
         error: any;
         errorMsg: string;
     } | null>;
-    send: (partialNotif: PartialUiNotif) => void;
+    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(): {

package/ui-notif.js

@@ -1,25 +1,54 @@
+// simple composable to display store a UI notification
+// this will be transmitted to frame parent if available (compatible with v-iframe uiNotification message type)
+// 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 getFullNotif (notif) {
-  if (typeof notif === 'string') { return { msg: notif, type: 'default' } }
+function getErrorMsg (error) {
+  if (typeof error === 'string') { return error }
+  if (typeof error.data === 'string') { return error.data }
+  if (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 'unknown error'
+}
+function getFullNotif (notif, defaultType = 'default') {
+  if (typeof notif === 'string') { return { msg: notif, type: defaultType } }
   if (notif.error) {
-    notif.type = 'error'
-    notif.errorMsg = (notif.error.response && (notif.error.response.data || notif.error.response.status)) || notif.error.message || notif.error
+    console.log('ERROR', notif.error)
+    return {
+      ...notif,
+      type: 'error',
+      errorMsg: getErrorMsg(notif.error)
+    }
   }
-  notif.type = notif.type || 'default'
-  if (inIframe) {
-    window.top?.postMessage({ vIframe: true, uiNotification: notif }, '*')
-  } else {
-    console.log('notification', notif)
+  return {
+    ...notif,
+    type: notif.type ?? defaultType
   }
-  throw new Error('invalid UI notification')
 }
 export const getUiNotif = () => {
-  const current = ref(null)
-  const send = (partialNotif) => {
-    current.value = getFullNotif(partialNotif)
+  const notification = ref(null)
+  const sendUiNotif = (partialNotif) => {
+    const notif = notification.value = getFullNotif(partialNotif)
+    if (inIframe) {
+      window.top?.postMessage({ vIframe: true, uiNotification: notif }, '*')
+    } else {
+      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 { current, send }
+  return { notification, sendUiNotif, withUiNotif }
 }
 // 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')
@@ -28,8 +57,8 @@ export function createUiNotif () {
   return { install (app) { app.provide(uiNotifKey, uiNotif) } }
 }
 export function useUiNotif () {
-  const session = inject(uiNotifKey)
-  if (!session) { throw new Error('useUiNotif requires using the plugin createUiNotif') }
-  return session
+  const uiNotif = inject(uiNotifKey)
+  if (!uiNotif) { throw new Error('useUiNotif requires using the plugin createUiNotif') }
+  return uiNotif
 }
 export default useUiNotif

package/vite.d.ts

@@ -0,0 +1,7 @@
+export declare const autoImports: (string | {
+    '@data-fair/lib-vue/session.js': string[];
+    '@data-fair/lib-vue/reactive-search-params.js': 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[];
+})[];

package/vite.js

@@ -0,0 +1,13 @@
+// made for https://github.com/unplugin/unplugin-auto-import
+export const autoImports = [
+  'vue',
+  'vue-i18n',
+  'vue-router',
+  {
+    '@data-fair/lib-vue/session.js': ['useSession'],
+    '@data-fair/lib-vue/reactive-search-params.js': ['useReactiveSearchParams'],
+    '@data-fair/lib-vue/locale-dayjs.js': ['useLocaleDayjs'],
+    '@data-fair/lib-vue/concept-filters.js': ['useConceptFilters'],
+    '@data-fair/lib-vue/ui-notif.js': ['useUiNotif']
+  }
+]

package/locale-dayjs-types.d.ts

@@ -1 +0,0 @@
-export {};