@dative-gpi/foundation-shared-services 1.0.192 → 1.0.193-value-data-composable

package/composables/index.ts

@@ -5,4 +5,5 @@ export * from "./useDateFormat";
 export * from "./useFiles";
 export * from "./useFoundationShared";
 export * from "./useRouting";
-export * from "./useDateExpression";
+export * from "./useDateExpression";
+export * from "./useTimeDuration";

package/composables/useTimeDuration.ts

@@ -0,0 +1,75 @@
+import { TimeComparisonType } from "@dative-gpi/foundation-shared-domain/enums";
+import { useDateExpression } from "@dative-gpi/foundation-shared-services/composables";
+import { MILLISECONDS_PER_DAY, MILLISECONDS_PER_WEEK, MILLISECONDS_PER_MONTH_APPROX, MILLISECONDS_PER_YEAR_APPROX } from "@dative-gpi/foundation-shared-services/config";
+
+export const useTimeDuration = () => {
+    /**
+     * Computes the duration between two timestamps, in **milliseconds**.
+     *
+     * Returns `null` if:
+     * - `periodStart` or `periodEnd` is missing,
+     * - a timestamp cannot be converted to a number,
+     * - the end is equal to or before the start.
+     *
+     * @param periodStart Date fixe (ISO-8601) ou expression relative (ex: 'now-1h', 'now/d'), ou `undefined`.
+     * @param periodEnd Date fixe (ISO-8601) ou expression relative (ex: 'now', 'now-1d/d'), ou `undefined`.
+     * @returns Durée en millisecondes, ou `0` si l'expression est invalide ou si la fin est avant le début.
+     */
+    const getPeriodDuration = (periodStart: string | undefined, periodEnd: string | undefined): number | null => {
+        if (!periodStart || !periodEnd) {
+            return null;
+        }
+        const { convert } = useDateExpression();
+
+        const startTimestamp = convert(periodStart);
+        const endTimestamp = convert(periodEnd);
+
+        if (isNaN(startTimestamp) || isNaN(endTimestamp)) {
+            return null;
+        }
+
+        const durationMs = endTimestamp - startTimestamp;
+        return durationMs > 0 ? durationMs : null;
+    };
+
+    /**
+     * Returns the duration (in **milliseconds**) for a given {@link TimeComparisonType}.
+     *
+     * - `Daily` / `Weekly`: fixed constants.
+     * - `Monthly` / `Yearly`: **approximate** constants (not exact calendar lengths).
+     * - `SinceReference`: duration between `periodStart` and `periodEnd` (needed only for this mode).
+     * - `None` / `Absolute`: returns `null` (no implied fixed duration).
+     *
+     * @param timeframe Timeframe mode to convert into a duration.
+     * @param periodStart Optional start timestamp string (usually ISO-8601). Used only for `SinceReference`.
+     * @param periodEnd Optional end timestamp string (usually ISO-8601). Used only for `SinceReference`.
+     * @returns Duration in **milliseconds**.
+     */
+    const getTimeframeDuration = (timeframe: TimeComparisonType, periodStart: string | null = null, periodEnd: string | null = null): number | null => {
+        switch (timeframe) {
+            case TimeComparisonType.SinceReference:
+                return getPeriodDuration(periodStart ?? undefined, periodEnd ?? undefined);
+            case TimeComparisonType.Daily:
+                return MILLISECONDS_PER_DAY;
+            case TimeComparisonType.Weekly:
+                return MILLISECONDS_PER_WEEK;
+            case TimeComparisonType.Monthly:
+                return MILLISECONDS_PER_MONTH_APPROX;
+            case TimeComparisonType.Yearly:
+                return MILLISECONDS_PER_YEAR_APPROX;
+            case TimeComparisonType.None:
+                // No timeframe selected: no duration.
+                return null;
+            case TimeComparisonType.Absolute:
+                // Absolute comparisons do not imply a fixed duration.
+                return null;
+            default:
+                return null;
+        }
+    };
+
+    return {
+        getPeriodDuration,
+        getTimeframeDuration,
+    };
+}

package/config/index.ts

@@ -1,2 +1,3 @@
 export * from "./literals";
+export * from "./timeDuration";
 export * from "./urls";

package/config/timeDuration/index.ts

@@ -0,0 +1 @@
+export * from "./timePerPeriod";

package/config/timeDuration/timePerPeriod.ts

@@ -0,0 +1,4 @@
+export const MILLISECONDS_PER_DAY = 1000 * 60 * 60 * 24;
+export const MILLISECONDS_PER_WEEK = MILLISECONDS_PER_DAY * 7;
+export const MILLISECONDS_PER_MONTH_APPROX = MILLISECONDS_PER_DAY * 30;
+export const MILLISECONDS_PER_YEAR_APPROX = MILLISECONDS_PER_DAY * 365;

package/package.json

@@ -4,7 +4,7 @@
     "url": "https://github.com/Dative-GPI/foundation-shared-ui.git"
   },
   "sideEffects": false,
-  "version": "1.0.192",
+  "version": "1.0.193-value-data-composable",
   "description": "",
   "publishConfig": {
     "access": "public"
@@ -13,7 +13,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@dative-gpi/foundation-shared-domain": "1.0.192",
+    "@dative-gpi/foundation-shared-domain": "1.0.193-value-data-composable",
     "@vueuse/core": "^14.0.0"
   },
   "peerDependencies": {
@@ -22,5 +22,5 @@
     "vue": "^3.4.38",
     "vue-router": "^4.3.0"
   },
-  "gitHead": "ee4d3a1f2581f8fc1765618f7b7b0aeb6368a0b2"
+  "gitHead": "e6d7d1fd7a3bc060cebb335596f4d95a6ce91356"
 }