@octans/ui 1.6.1 → 1.7.0

package/dist/components/FileInput/FileInput.vue.d.ts

@@ -398,6 +398,9 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
             timezone: {
                 type: StringConstructor;
             };
+            inputTimezone: {
+                type: StringConstructor;
+            };
         }>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
             [key: string]: any;
         }>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
@@ -420,6 +423,9 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
             timezone: {
                 type: StringConstructor;
             };
+            inputTimezone: {
+                type: StringConstructor;
+            };
         }>> & Readonly<{}>, {
             locale: string;
             currency: string;

package/dist/components/FileInput/ItemList.vue.d.ts

@@ -43,6 +43,9 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
         timezone: {
             type: StringConstructor;
         };
+        inputTimezone: {
+            type: StringConstructor;
+        };
     }>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
         [key: string]: any;
     }>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
@@ -65,6 +68,9 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
         timezone: {
             type: StringConstructor;
         };
+        inputTimezone: {
+            type: StringConstructor;
+        };
     }>> & Readonly<{}>, {
         locale: string;
         currency: string;

package/dist/components/Formatter/Formatter.vue.d.ts

@@ -26,6 +26,20 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     timezone: {
         type: StringConstructor;
     };
+    /**
+     * IANA time zone a `value` that names no zone of its own is READ in.
+     *
+     * `timezone` is the clock the date is shown on; this is the clock it was
+     * written on. `'2024-03-15 02:00:00'` straight out of a MySQL `DATETIME`
+     * names no instant, so without this it is taken as the viewer's own local
+     * time and the same row reads as a different moment in every country.
+     *
+     * Usually you want `setInputTimezone('UTC')` at app start. This is the
+     * per-instance override, for the one feed that disagrees.
+     */
+    inputTimezone: {
+        type: StringConstructor;
+    };
 }>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
     [key: string]: any;
 }>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
@@ -54,6 +68,20 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     timezone: {
         type: StringConstructor;
     };
+    /**
+     * IANA time zone a `value` that names no zone of its own is READ in.
+     *
+     * `timezone` is the clock the date is shown on; this is the clock it was
+     * written on. `'2024-03-15 02:00:00'` straight out of a MySQL `DATETIME`
+     * names no instant, so without this it is taken as the viewer's own local
+     * time and the same row reads as a different moment in every country.
+     *
+     * Usually you want `setInputTimezone('UTC')` at app start. This is the
+     * per-instance override, for the one feed that disagrees.
+     */
+    inputTimezone: {
+        type: StringConstructor;
+    };
 }>> & Readonly<{}>, {
     locale: string;
     currency: string;

package/dist/lib.d.ts

@@ -1,5 +1,5 @@
 import { format } from './utils/format';
-import { setLocale, setTimezone, getTimezone } from './utils/date';
+import { setLocale, setTimezone, getTimezone, setInputTimezone, getInputTimezone } from './utils/date';
 import { setTheme, toggleTheme, getResolvedTheme, getThemePreference, onThemeChange, persistTheme } from './utils/theme';
 import { translate, setTranslations, addTranslations, setTranslationLocale, getTranslationLocale, getAvailableLocales, TranslationDictionary } from './utils/translate';
 import * as components from './components/all';
@@ -9,10 +9,32 @@ interface PluginOptions {
     translations?: Record<string, TranslationDictionary>;
     /** Locale to activate at install time. Defaults to `'en'`. */
     locale?: string;
+    /**
+     * Library-wide display time zone to activate at install time, as an IANA id
+     * (`'Australia/Sydney'`). Equivalent to calling `setTimezone` yourself.
+     *
+     * Left unset, dates render in the viewer's own clock. Affects DISPLAY only —
+     * a stored value is not reinterpreted. A zone this runtime does not know
+     * warns and falls back rather than throwing.
+     */
+    timezone?: string;
+    /**
+     * Time zone that date strings carrying no zone of their own are READ in, as
+     * an IANA id — `'UTC'` for the usual case. Equivalent to calling
+     * `setInputTimezone` yourself.
+     *
+     * The companion to `timezone`, and the other half of the same question:
+     * `timezone` is the clock dates are SHOWN on, this is the clock they were
+     * WRITTEN on. A MySQL `DATETIME` comes back as `'2024-03-15 02:00:00'`,
+     * which names no instant, so left unset it is read as the viewer's own local
+     * time — and the same stored row then means something different to a reader
+     * in Sydney than to one in London, whatever `timezone` says.
+     */
+    inputTimezone?: string;
 }
 export * from './components/all';
 export { addCollection, addIcon } from '@iconify/vue';
-export { setTimezone, getTimezone } from './utils/date';
+export { setTimezone, getTimezone, setInputTimezone, getInputTimezone } from './utils/date';
 export { translate, $t, setTranslations, addTranslations, setTranslationLocale, getTranslationLocale, getAvailableLocales, type TranslationDictionary } from './utils/translate';
 export { setTheme, toggleTheme, getResolvedTheme, getThemePreference, onThemeChange, persistTheme, type ThemeType, type ThemePreferenceType } from './utils/theme';
 export { listCustomThemes, getCustomTheme, saveCustomTheme, deleteCustomTheme, applyCustomTheme, clearCustomTheme, restoreCustomTheme, getActiveCustomThemeId, getResolvedTokenValue, exportCustomTheme, importCustomTheme, createThemeId, ThemeImportError, type CustomTheme } from './utils/customTheme';
@@ -32,6 +54,8 @@ declare const UI: {
     t: typeof translate;
     setTimezone: typeof setTimezone;
     getTimezone: typeof getTimezone;
+    setInputTimezone: typeof setInputTimezone;
+    getInputTimezone: typeof getInputTimezone;
     setTranslations: typeof setTranslations;
     addTranslations: typeof addTranslations;
     setTranslationLocale: typeof setTranslationLocale;