@data-fair/lib-vue 1.24.1 → 1.25.0

package/async-action.d.ts

@@ -1,7 +1,7 @@
 import { type Ref } from 'vue';
 import { type PartialUiNotif, type UiNotif } from './ui-notif.js';
 type Finally = () => Promise<void> | void;
-type AsyncActionOptions = {
+export type AsyncActionOptions = {
     error?: string;
     success?: PartialUiNotif;
     catch?: 'error' | 'success' | 'all';

package/edit-fetch.d.ts

@@ -0,0 +1,26 @@
+import { type Ref } from 'vue';
+import { type UseFetchOptions } from './fetch.js';
+import { AsyncActionOptions } from './async-action.js';
+type UseEditFetchOptions = UseFetchOptions & {
+    patch?: boolean;
+    saveOptions?: AsyncActionOptions;
+};
+type OptionalUrl = string | null | undefined;
+export declare function useEditFetch<T extends Record<string, any>>(url: OptionalUrl | Ref<OptionalUrl> | (() => OptionalUrl), options?: UseEditFetchOptions): {
+    fetch: {
+        data: Ref<T | null, T | null>;
+        fullUrl: Ref<string | null>;
+        loading: Ref<boolean>;
+        initialized: Ref<boolean>;
+        error: Ref<any>;
+        refresh: () => Promise<T | null>;
+    };
+    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>;
+    save: {
+        execute: () => Promise<void>;
+        notif: Ref<import("./ui-notif.js").UiNotif | undefined>;
+        loading: Ref<boolean>;
+        error: Ref<string | undefined>;
+    };
+};
+export default useEditFetch;

package/edit-fetch.js

@@ -0,0 +1,37 @@
+import { ref, watch } from 'vue';
+import { ofetch } from 'ofetch';
+import { useFetch } from './fetch.js';
+import useAsyncAction from './async-action.js';
+import equal from 'fast-deep-equal';
+export function useEditFetch(url, options = {}) {
+    const fetch = useFetch(url, options);
+    const data = ref(null);
+    watch(fetch.data, () => {
+        // TODO: check for local changes before overwriting ?
+        data.value = fetch.data.value;
+    });
+    const save = useAsyncAction(async () => {
+        if (!data.value || !fetch.data.value)
+            throw new Error('cannot save data that has not been fetched yet');
+        if (options.patch) {
+            const patch = {};
+            for (const key of Object.keys(data.value)) {
+                if (!equal(data.value[key], fetch.data.value[key]))
+                    patch[key] = data.value[key];
+            }
+            if (!Object.keys(patch).length)
+                return;
+            await ofetch(fetch.fullUrl.value, { method: 'PATCH', body: patch });
+        }
+        else {
+            // TODO: add if-unmodified-since header ?
+            await ofetch(fetch.fullUrl.value, { method: 'PUT', body: data.value });
+        }
+    }, options.saveOptions);
+    return {
+        fetch,
+        data,
+        save
+    };
+}
+export default useEditFetch;

package/fetch.d.ts

@@ -1,14 +1,16 @@
 import type { QueryObject } from 'ufo';
 import type { Ref } from 'vue';
-type UseFetchOptions = {
-    query?: QueryObject | Ref<QueryObject>;
+import { MaybeRefOrGetter } from 'vue';
+export type UseFetchOptions = {
+    query?: MaybeRefOrGetter<QueryObject>;
     watch?: Boolean;
     notifError?: Boolean;
     immediate?: Boolean;
 };
 type OptionalUrl = string | null | undefined;
-export declare function useFetch<T>(url: OptionalUrl | Ref<OptionalUrl> | (() => OptionalUrl), options?: UseFetchOptions): {
+export declare function useFetch<T>(url: MaybeRefOrGetter<OptionalUrl>, options?: UseFetchOptions): {
     data: Ref<T | null>;
+    fullUrl: Ref<string | null>;
     loading: Ref<boolean>;
     initialized: Ref<boolean>;
     error: Ref<any>;

package/fetch.js

@@ -1,16 +1,16 @@
 import { ofetch } from 'ofetch';
 import { withQuery } from 'ufo';
-import { computed, isRef, watch, ref, shallowRef, readonly, shallowReadonly } from 'vue';
+import { computed, watch, ref, shallowRef, readonly, shallowReadonly, toValue } from 'vue';
 import { useUiNotif } from '@data-fair/lib-vue/ui-notif.js';
 export function useFetch(url, options = {}) {
     const { sendUiNotif } = useUiNotif();
     if (typeof url === 'function')
         url = computed(url);
     const fullUrl = computed(() => {
-        let fullUrl = isRef(url) ? url.value : url;
+        let fullUrl = toValue(url);
         if (!fullUrl)
             return null;
-        const query = isRef(options.query) ? options.query.value : options.query;
+        const query = toValue(options.query);
         if (query)
             fullUrl = withQuery(fullUrl, query);
         return fullUrl;
@@ -51,6 +51,7 @@ export function useFetch(url, options = {}) {
     }
     return {
         initialized: readonly(initialized),
+        fullUrl: readonly(fullUrl),
         data: shallowReadonly(data),
         loading: readonly(loading),
         error: shallowReadonly(error),

package/format/bytes.d.ts

@@ -1,2 +1 @@
-export declare function formatBytes(bytes: number | string, locale?: string): string;
-export default formatBytes;
+export * from '@data-fair/lib-utils/format/bytes.js';

package/format/bytes.js

@@ -1,22 +1,2 @@
-const locales = {
-    fr: [[0, 'octet'], [1, 'octets'], [1000, 'ko'], [1000 * 1000, 'Mo'], [1000 * 1000 * 1000, 'Go'], [1000 * 1000 * 1000 * 1000, 'To'], [1000 * 1000 * 1000 * 1000 * 1000, 'Po']],
-    en: [[0, 'byte'], [1, 'bytes'], [1000, 'kb'], [1000 * 1000, 'Mb'], [1000 * 1000 * 1000, 'Gb'], [1000 * 1000 * 1000 * 1000, 'Tb'], [1000 * 1000 * 1000 * 1000 * 1000, 'Pb']]
-};
-export function formatBytes(bytes, locale = 'fr') {
-    const bytesInt = Math.abs(typeof bytes === 'string' ? parseInt(bytes, 10) : bytes);
-    const def = locales[locale] ?? locales.en;
-    for (let i = 0; i < def.length; i++) {
-        const step = def[i][0];
-        if (bytesInt < step || i === def.length - 1) {
-            const value = bytesInt / (def[i - 1][0] || 1);
-            let digits = 2;
-            if (value > 1)
-                digits = 1;
-            if (value > 10)
-                digits = 0;
-            return value.toLocaleString(locale, { maximumFractionDigits: digits }) + ' ' + def[i - 1][1];
-        }
-    }
-    return ''; // this is only for strict typing, but the code cannot go there, the return in the loop is always called
-}
-export default formatBytes;
+// re-export for retro-compatiblity
+export * from '@data-fair/lib-utils/format/bytes.js';

package/format/field.d.ts

@@ -1,3 +1 @@
-import type { Field } from '@data-fair/lib-common-types/application/index.js';
-export declare function formatField(item: Record<string, string | null | undefined | number | boolean>, field: Field): string;
-export declare function getFieldLabel(field: Field): string;
+export * from '@data-fair/lib-utils/format/field.js';

package/format/field.js

@@ -1,28 +1,2 @@
-// TODO: use locale-dayjs for localization of date formats
-import dayjs from 'dayjs';
-export function formatField(item, field) {
-    const value = item[field.key];
-    if (value === undefined || value === null || value === '')
-        return '';
-    if (field['x-labels']?.['' + item[field.key]])
-        return field['x-labels']['' + item[field.key]];
-    if (field.type === 'number' || field.type === 'integer')
-        return value.toLocaleString('fr');
-    if (typeof value === 'boolean')
-        return value ? 'Oui' : 'Non';
-    if (typeof value === 'string') {
-        if (field['x-refersTo'] === 'http://schema.org/Date' ||
-            field['x-refersTo'] === 'https://schema.org/startDate' ||
-            field['x-refersTo'] === 'https://schema.org/endDate' ||
-            field['x-refersTo'] === 'http://schema.org/dateCreated') {
-            if (field.format === 'date-time')
-                return dayjs(value).format('DD/MM/YYYY, HH[h]mm');
-            else
-                return dayjs(value).format('DD/MM/YYYY');
-        }
-    }
-    return '' + value;
-}
-export function getFieldLabel(field) {
-    return field.title || field['x-originalName'] || field.key;
-}
+// re-export for retro-compatiblity
+export * from '@data-fair/lib-utils/format/field.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@data-fair/lib-vue",
-  "version": "1.24.1",
+  "version": "1.25.0",
   "description": "Composables and other utilities for Vue applications in the data-fair stack.",
   "main": "index.js",
   "files": [
@@ -29,7 +29,7 @@
   },
   "dependencies": {
     "@data-fair/lib-common-types": "^1.7.1",
-    "@data-fair/lib-utils": "^1.0.0",
+    "@data-fair/lib-utils": "^1.9.0",
     "fast-deep-equal": "^3.1.3",
     "jwt-decode": "^4.0.0",
     "universal-cookie": "^7.2.0"

package/session.d.ts

@@ -2,7 +2,7 @@ import { type IncomingMessage } from 'node:http';
 import { type Ref, type ComputedRef, type 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';
+import { type AccountKeys, type SessionState, type SessionStateAuthenticated } from '@data-fair/lib-common-types/session/index.js';
 export * from '@data-fair/lib-common-types/session/index.js';
 interface GenericCookies {
     get: (key: string) => string | undefined;
@@ -63,6 +63,7 @@ export interface SiteInfo {
     logo?: string;
     dark?: boolean;
     colors: Colors;
+    owner: AccountKeys;
 }
 type Theme = 'default' | 'dark' | 'hc' | 'hc-dark';
 export interface Session {

package/session.js

@@ -269,7 +269,9 @@ export async function getSession(initOptions) {
         goTo(null);
     };
     const keepalive = async () => {
-        if (state.user == null)
+        // check cookies.get('id_token') not state.user so that we do a keepalive on expired id tokens
+        // as we might have an exchange token
+        if (!cookies.get('id_token'))
             return;
         if (!ssr) {
             window.localStorage.setItem('sd-keepalive' + options.sitePath, `${new Date().getTime()}`);
@@ -284,8 +286,8 @@ export async function getSession(initOptions) {
             else {
                 throw err;
             }
-            readState();
         }
+        readState();
     };
     const refreshSiteInfo = async () => {
         console.warn('@data-fair/lib-vue/session refreshSiteInfo is deprecated');
@@ -301,7 +303,8 @@ export async function getSession(initOptions) {
                 logo: siteInfo.theme.logo,
                 colors: siteInfo.theme.colors,
                 authMode: siteInfo.authMode,
-                authOnlyOtherSite: siteInfo.authOnlyOtherSite
+                authOnlyOtherSite: siteInfo.authOnlyOtherSite,
+                owner: siteInfo.owner
             };
             if (theme.value == null)
                 theme.value = getDefaultTheme(siteInfo);
@@ -331,8 +334,7 @@ export async function getSession(initOptions) {
     // also run an auto-refresh loop
     if (!ssr && !inIframe && !('triggerCapture' in window)) {
         const lastKeepalive = window.localStorage.getItem('sd-keepalive' + options.sitePath);
-        // check cookies.get('id_token') not state.user so that we do a keepalive on expired id tokens
-        if (cookies.get('id_token') && (!lastKeepalive || (new Date().getTime() - Number(lastKeepalive)) > 10000)) {
+        if (!lastKeepalive || (new Date().getTime() - Number(lastKeepalive)) > 10000) {
             await keepalive();
         }
         const refreshLoopDelay = 10 * 60 * 1000; // 10 minutes

package/vite.d.ts

@@ -8,6 +8,7 @@ export declare const autoImports: (string | {
     '@data-fair/lib-vue/ws.js': string[];
     '@data-fair/lib-vue/async-action.js': string[];
     '@data-fair/lib-vue/deep-diff.js': string[];
+    '@data-fair/lib-vue/format/bytes.js': string[];
 })[];
 export declare function ClosePlugin(): {
     name: string;

package/vite.js

@@ -13,6 +13,7 @@ export const autoImports = [
         '@data-fair/lib-vue/ws.js': ['useWS'],
         '@data-fair/lib-vue/async-action.js': ['useAsyncAction'],
         '@data-fair/lib-vue/deep-diff.js': ['computedDeepDiff', 'watchDeepDiff'],
+        '@data-fair/lib-vue/format/bytes.js': ['formatBytes'],
     }
 ];
 // cf https://stackoverflow.com/questions/75839993/vite-build-hangs-forever/76920975#76920975