stream-chat-react 13.0.4 → 13.1.0

package/dist/i18n/types.d.ts

@@ -9,6 +9,59 @@ export type TimestampFormatterOptions = {
     calendarFormats?: Record<string, string>;
     format?: string;
 };
+/**
+ * import dayjs from 'dayjs';
+ * import duration from 'dayjs/plugin/duration';
+ *
+ * dayjs.extend(duration);
+ *
+ * // Basic formatting
+ * dayjs.duration(1000).format('HH:mm:ss'); // "00:00:01"
+ * dayjs.duration(3661000).format('HH:mm:ss'); // "01:01:01"
+ *
+ * // Different format tokens
+ * dayjs.duration(3661000).format('D[d] H[h] m[m] s[s]'); // "0d 1h 1m 1s"
+ * dayjs.duration(3661000).format('D [days] H [hours] m [minutes] s [seconds]'); // "0 days 1 hours 1 minutes 1 seconds"
+ *
+ * // Zero padding
+ * dayjs.duration(1000).format('HH:mm:ss'); // "00:00:01"
+ * dayjs.duration(1000).format('H:m:s'); // "0:0:1"
+ *
+ * // Different units
+ * dayjs.duration(3661000).format('D'); // "0"
+ * dayjs.duration(3661000).format('H'); // "1"
+ * dayjs.duration(3661000).format('m'); // "1"
+ * dayjs.duration(3661000).format('s'); // "1"
+ *
+ * // Complex examples
+ * dayjs.duration(3661000).format('DD:HH:mm:ss'); // "00:01:01:01"
+ * dayjs.duration(3661000).format('D [days] HH:mm:ss'); // "0 days 01:01:01"
+ * dayjs.duration(3661000).format('H[h] m[m] s[s]'); // "1h 1m 1s"
+ *
+ * // Negative durations
+ * dayjs.duration(-3661000).format('HH:mm:ss'); // "-01:01:01"
+ *
+ * // Long durations
+ * dayjs.duration(86400000).format('D [days]'); // "1 days"
+ * dayjs.duration(2592000000).format('M [months]'); // "30 months"
+ *
+ *
+ * Format tokens:
+ * D - days
+ * H - hours
+ * m - minutes
+ * s - seconds
+ * S - milliseconds
+ * M - months
+ * Y - years
+ * You can also use:
+ * HH, mm, ss for zero-padded numbers
+ * [text] for literal text
+ */
+export type DurationFormatterOptions = {
+    format?: string;
+    withSuffix?: boolean;
+};
 export type TDateTimeParserInput = string | number | Date;
 export type TDateTimeParserOutput = string | number | Date | Dayjs.Dayjs | Moment;
 export type TDateTimeParser = (input?: TDateTimeParserInput) => TDateTimeParserOutput;
@@ -22,5 +75,6 @@ export type DateFormatterOptions = TimestampFormatterOptions & {
 };
 export type CustomFormatters = Record<string, FormatterFactory<any>>;
 export type PredefinedFormatters = {
+    durationFormatter: FormatterFactory<number>;
     timestampFormatter: FormatterFactory<string | Date>;
 };

package/dist/i18n/utils.d.ts

@@ -9,6 +9,6 @@ export declare const isDayOrMoment: (output: TDateTimeParserOutput) => output is
 export declare const isDate: (output: unknown) => output is Date;
 export declare function getDateString({ calendar, calendarFormats, format, formatDate, messageCreatedAt, t, tDateTimeParser, timestampTranslationKey, }: DateFormatterOptions): string | number | null;
 export declare const predefinedFormatters: PredefinedFormatters;
-export declare const defaultTranslatorFunction: TFunction;
+export declare const defaultTranslatorFunction: TFunction<"translation", undefined>;
 export declare const defaultDateTimeParser: (input?: TDateTimeParserInput) => Dayjs.Dayjs;
 export declare const isLanguageSupported: (language: string) => language is SupportedTranslations;

package/dist/i18n/utils.js

@@ -1,4 +1,4 @@
-import Dayjs from 'dayjs';
+import Dayjs, { isDayjs } from 'dayjs';
 export const notValidDateWarning = 'MessageTimestamp was called without a message, or message has invalid created_at date.';
 export const noParsingFunctionWarning = 'MessageTimestamp was called but there is no datetime parsing function available';
 export const isNumberOrString = (output) => typeof output === 'string' || typeof output === 'number';
@@ -54,6 +54,12 @@ export function getDateString({ calendar, calendarFormats, format, formatDate, m
     return null;
 }
 export const predefinedFormatters = {
+    durationFormatter: (streamI18n) => (value, _, { format, withSuffix }) => {
+        if (format && isDayjs(streamI18n.DateTimeParser)) {
+            return streamI18n.DateTimeParser.duration(value).format(format);
+        }
+        return streamI18n.DateTimeParser.duration(value).humanize(!!withSuffix);
+    },
     timestampFormatter: (streamI18n) => (value, _, { calendarFormats, ...options }) => {
         let parsedCalendarFormats;
         try {
@@ -82,7 +88,7 @@ export const predefinedFormatters = {
         return result;
     },
 };
-export const defaultTranslatorFunction = (key) => key;
+export const defaultTranslatorFunction = ((key) => key);
 export const defaultDateTimeParser = (input) => Dayjs(input);
 export const isLanguageSupported = (language) => {
     const translations = [