@opengeoweb/time-slider 19.6.1 → 20.0.0

package/dist/src/lib/components/TimeSliderButtons/AnimationLengthPanel/AnchorTimeField.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+export interface AnchorTimeFieldProps {
+    value: string;
+    label: string;
+    onChange: (anchorTime: string) => void;
+    disabled?: boolean;
+}
+export declare const anchorTimeToPickerDate: (anchorTime: string) => Date | null;
+export declare const pickerDateToAnchorTime: (pickerDate: Date) => string;
+export declare const AnchorTimeField: React.FC<AnchorTimeFieldProps>;

package/dist/src/lib/components/TimeSliderButtons/AnimationLengthPanel/AnimationLengthMenu.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import type { AnimationLengthSetting } from './animationLengthUtils';
+export interface AnimationLengthMenuProps {
+    setting: AnimationLengthSetting;
+    onChange: (setting: AnimationLengthSetting, isStep?: boolean) => void;
+    onInputChange?: () => void;
+    animationStartTime?: string;
+    animationEndTime?: string;
+    autoTimeStepLayerName?: string;
+    timeStep?: number;
+    isAutoDisabled?: boolean;
+    disabled?: boolean;
+    referenceTimeFromLayer?: string;
+}
+export declare const AnimationLengthMenu: React.FC<AnimationLengthMenuProps>;

package/dist/src/lib/components/TimeSliderButtons/AnimationLengthPanel/AnimationLengthPanel.d.ts

@@ -0,0 +1,16 @@
+import React from 'react';
+import type { AnimationLengthSetting } from './animationLengthUtils';
+export interface AnimationLengthPanelProps {
+    setting: AnimationLengthSetting;
+    onChange: (setting: AnimationLengthSetting, isStep?: boolean) => void;
+    onInputChange?: () => void;
+    animationStartTime?: string;
+    animationEndTime?: string;
+    autoTimeStepLayerName?: string;
+    timeStep?: number;
+    isAutoDisabled?: boolean;
+    disabled?: boolean;
+    referenceTimeFromLayer?: string;
+}
+export declare const asDisplayTime: (time?: string) => string;
+export declare const AnimationLengthPanel: React.FC<AnimationLengthPanelProps>;

package/dist/src/lib/components/TimeSliderButtons/AnimationLengthPanel/animationLengthUtils.d.ts

@@ -0,0 +1,114 @@
+export declare enum AnimationLengthMode {
+    Auto = "auto",
+    Now = "now",
+    RecurringPeriod = "recurringPeriod",
+    ReferenceTime = "referenceTime",
+    Exact = "exact"
+}
+export type TimeUnit = 'years' | 'months' | 'weeks' | 'days' | 'hours' | 'minutes';
+export declare const timeUnits: TimeUnit[];
+export interface RelativeTimeOffset {
+    value: number;
+    unit: TimeUnit;
+}
+export interface OffsetSelections {
+    startOffset: RelativeTimeOffset;
+    endOffset: RelativeTimeOffset;
+}
+export interface RecurringPeriodSelections extends OffsetSelections {
+    /** Time of day in UTC as HH:mm. */
+    anchorTime: string;
+}
+/** Exact names its instants outright rather than counting offsets from an anchor. */
+export interface ExactSelections {
+    animationStartTime: string;
+    animationEndTime: string;
+}
+/**
+ * Each mode keeps its own selections under a key named after it, so switching modes
+ * cannot overwrite another mode's setup. The selected mode's own slice is required.
+ */
+export type AnimationLengthSetting = {
+    mode: AnimationLengthMode.Auto;
+    now?: OffsetSelections;
+    recurringPeriod?: RecurringPeriodSelections;
+    referenceTime?: OffsetSelections;
+    exact?: ExactSelections;
+} | {
+    mode: AnimationLengthMode.Now;
+    now: OffsetSelections;
+    recurringPeriod?: RecurringPeriodSelections;
+    referenceTime?: OffsetSelections;
+    exact?: ExactSelections;
+} | {
+    mode: AnimationLengthMode.RecurringPeriod;
+    now?: OffsetSelections;
+    recurringPeriod: RecurringPeriodSelections;
+    referenceTime?: OffsetSelections;
+    exact?: ExactSelections;
+} | {
+    mode: AnimationLengthMode.ReferenceTime;
+    now?: OffsetSelections;
+    recurringPeriod?: RecurringPeriodSelections;
+    referenceTime: OffsetSelections;
+    exact?: ExactSelections;
+} | {
+    mode: AnimationLengthMode.Exact;
+    now?: OffsetSelections;
+    recurringPeriod?: RecurringPeriodSelections;
+    referenceTime?: OffsetSelections;
+    exact: ExactSelections;
+};
+export interface AnimationRange {
+    animationStartTime: string;
+    animationEndTime: string;
+}
+export declare const defaultStartOffset: RelativeTimeOffset;
+export declare const defaultEndOffset: RelativeTimeOffset;
+export declare const defaultOffsetSelections: OffsetSelections;
+export declare const unitTranslationKey: Record<TimeUnit, string>;
+export declare const shortUnitTranslationKey: Record<TimeUnit, string>;
+export declare const modeTranslationKey: Record<AnimationLengthMode, string>;
+export declare const ANCHOR_MINUTE_STEP = 5;
+/**
+ * Reads the UTC fields directly: `dateUtils.dateToString` formats a local twin of the
+ * date, which a DST gap shifts by an hour.
+ */
+export declare const toAnchorTime: (date: Date) => string;
+export declare const isAnchoredMode: (mode?: AnimationLengthMode) => boolean;
+/** Narrows the mode so the compiler can require an anchor time alongside it. */
+export declare const isRecurringPeriodMode: (mode: AnimationLengthMode) => mode is AnimationLengthMode.RecurringPeriod;
+export declare const isValidAnchorTime: (anchorTime?: string) => boolean;
+/** The offsets of whichever mode is selected; the modes without offsets use the defaults. */
+export declare const activeOffsets: (setting: AnimationLengthSetting) => OffsetSelections;
+export declare const defaultRecurringPeriodSelections: (now?: Date) => RecurringPeriodSelections;
+/** Presets carry settings the compiler cannot vouch for, so the selected mode is given the slice it needs. */
+export declare const withModeSelections: (setting: AnimationLengthSetting, now?: Date) => AnimationLengthSetting;
+/**
+ * A recurring period anchors on its time of day within the current UTC date, so the
+ * window it resolves rolls onto the next day once the clock passes midnight.
+ */
+export declare const resolveAnchorInstant: (setting: AnimationLengthSetting, now?: Date) => Date;
+/**
+ * Offsets are signed: negative lands before the anchor, positive after. They are
+ * applied as calendar durations, so "+ 1 month" lands on the same day of the next
+ * month rather than a fixed number of days later.
+ */
+export declare const resolveAnimationRange: (setting: AnimationLengthSetting, now?: Date) => AnimationRange;
+/** Offsets can use different units, so validity is decided on the resolved instants. */
+/** Exact names its range outright; every other mode resolves one from its offsets. */
+export declare const settingRange: (setting: AnimationLengthSetting, now?: Date) => AnimationRange;
+export declare const isValidAnimationLength: (setting: AnimationLengthSetting, now?: Date) => boolean;
+/** Frames the animation may hold; the range is expanded one entry per time step. */
+export declare const MAX_ANIMATION_STEPS = 10000;
+/**
+ * The cost of an animation is its span divided by the time step, so a wide range
+ * is affordable with a coarse step and unaffordable with a fine one.
+ */
+export declare const isWithinAnimationStepLimit: (setting: AnimationLengthSetting, timeStepInMinutes: number | undefined, now?: Date) => boolean;
+export declare const toExactAnimationTime: (date: Date) => string;
+/** A day either side of now, so an exact window opens on something usable. */
+export declare const defaultExactSelections: (now?: Date) => ExactSelections;
+/** Starts Exact from whatever range is already on screen, falling back to the defaults. */
+export declare const exactAnimationLengthFrom: ({ animationStartTime, animationEndTime }: Partial<AnimationRange>, now?: Date) => AnimationLengthSetting;
+export declare const getAnimationLengthFromRange: (mode: AnimationLengthMode, { animationStartTime, animationEndTime }: AnimationRange, now?: Date) => AnimationLengthSetting;

package/dist/src/lib/components/TimeSliderButtons/AnimationLengthPanel/index.d.ts

@@ -0,0 +1,4 @@
+export * from './AnchorTimeField';
+export * from './animationLengthUtils';
+export * from './AnimationLengthMenu';
+export * from './AnimationLengthPanel';

package/dist/src/lib/components/TimeSliderButtons/index.d.ts

@@ -1,4 +1,5 @@
 export * from './AnimationLengthButton/AnimationLengthButton';
+export * from './AnimationLengthPanel';
 export * from './AutoUpdateButton/AutoUpdateButton';
 export * from './BackwardForwardStepButton/BackwardForwardStepButton';
 export * from './ControlButtons/ControlButtons';

package/package.json

@@ -1,46 +1,46 @@
 {
-  "name": "@opengeoweb/time-slider",
-  "version": "19.6.1",
-  "description": "GeoWeb time-slider library for the opengeoweb project",
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "git@gitlab.com:opengeoweb/opengeoweb.git"
-  },
-  "main": "./dist/index.esm.js",
-  "module": "./dist/index.esm.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    "./package.json": "./package.json",
-    ".": {
-      "@opengeoweb/source": "./src/index.ts",
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.esm.js",
-      "default": "./dist/index.esm.js"
-    }
-  },
-  "dependencies": {
-    "@opengeoweb/shared": "*",
-    "lodash": "^4.18.1",
-    "@opengeoweb/theme": "*",
-    "@mui/x-date-pickers": "^9.3.0",
-    "@mui/system": "^9.0.1",
-    "i18next": "^25.0.1",
-    "@mui/material": "^9.0.1",
-    "react-i18next": "^15.1.1"
-  },
-  "peerDependencies": {
-    "react": "19",
-    "@emotion/react": "*",
-    "@emotion/styled": "*"
-  },
-  "devDependencies": {
-    "eslint-plugin-storybook": "10.3.3"
-  },
-  "files": [
-    "dist",
-    "!dist/package.json",
-    "README.md",
-    "package.json"
-  ]
-}
+    "name": "@opengeoweb/time-slider",
+    "version": "20.0.0",
+    "description": "GeoWeb time-slider library for the opengeoweb project",
+    "license": "Apache-2.0",
+    "repository": {
+        "type": "git",
+        "url": "git@gitlab.com:opengeoweb/opengeoweb.git"
+    },
+    "main": "./dist/index.esm.js",
+    "module": "./dist/index.esm.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        "./package.json": "./package.json",
+        ".": {
+            "@opengeoweb/source": "./src/index.ts",
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.esm.js",
+            "default": "./dist/index.esm.js"
+        }
+    },
+    "dependencies": {
+        "@opengeoweb/shared": "20.0.0",
+        "lodash": "^4.18.1",
+        "@opengeoweb/theme": "20.0.0",
+        "@mui/x-date-pickers": "^9.3.0",
+        "@mui/system": "^9.0.1",
+        "i18next": "^25.0.1",
+        "@mui/material": "^9.0.1",
+        "react-i18next": "^15.1.1"
+    },
+    "peerDependencies": {
+        "react": "19",
+        "@emotion/react": "*",
+        "@emotion/styled": "*"
+    },
+    "devDependencies": {
+        "eslint-plugin-storybook": "10.3.3"
+    },
+    "files": [
+        "dist",
+        "!dist/package.json",
+        "README.md",
+        "package.json"
+    ]
+}