@box/readable-time 1.39.52

package/dist/i18n/zh-TW.properties

@@ -0,0 +1,12 @@
+# The time that an event occurred
+groupSharedFeatures.readableTime.eventTime = {time, date, medium}
+# The time that an event occurred at a given date with the year included
+groupSharedFeatures.readableTime.eventTimeDate = {time, date, medium} {time, time, short}
+# The time that an event occurred at a given date without the year included
+groupSharedFeatures.readableTime.eventTimeDateShort = {date} {time, time, short}
+# The time that an event occurred today
+groupSharedFeatures.readableTime.eventTimeToday = 今天 {time, time, short}
+# The time that an event occurred at a given date with the weekday included
+groupSharedFeatures.readableTime.eventTimeWeekdayLong = {weekday} {time, date, medium}
+# The time that an event occurred yesterday
+groupSharedFeatures.readableTime.eventTimeYesterday = 昨天 {time, time, short}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { ReadableTime, type ReadableTimeProps } from './lib/readable-time';
+export { getReadableTime, type GetReadableTime, type GetReadableTimeArgs } from './lib/get-readable-time';

package/dist/types/lib/__tests__/testfiles/i18n/ja-JP.d.ts

@@ -0,0 +1,9 @@
+declare const _default: {
+    'groupSharedFeatures.readableTime.eventTime': string;
+    'groupSharedFeatures.readableTime.eventTimeDate': string;
+    'groupSharedFeatures.readableTime.eventTimeDateShort': string;
+    'groupSharedFeatures.readableTime.eventTimeToday': string;
+    'groupSharedFeatures.readableTime.eventTimeWeekdayLong': string;
+    'groupSharedFeatures.readableTime.eventTimeYesterday': string;
+};
+export default _default;

package/dist/types/lib/__tests__/testfiles/i18n/ru-RU.d.ts

@@ -0,0 +1,9 @@
+declare const _default: {
+    'groupSharedFeatures.readableTime.eventTime': string;
+    'groupSharedFeatures.readableTime.eventTimeDate': string;
+    'groupSharedFeatures.readableTime.eventTimeDateShort': string;
+    'groupSharedFeatures.readableTime.eventTimeToday': string;
+    'groupSharedFeatures.readableTime.eventTimeWeekdayLong': string;
+    'groupSharedFeatures.readableTime.eventTimeYesterday': string;
+};
+export default _default;

package/dist/types/lib/constants.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Represents the number of milliseconds in one hour.
+ * 60 * 60 * 1000
+ */
+export declare const ONE_HOUR_MS = 3600000;
+/**
+ * A list of languages that do not have a grammar for uppercase (e.g., Russian)
+ */
+export declare const nonUppercaseLocales: string[];

package/dist/types/lib/get-readable-time.d.ts

@@ -0,0 +1,15 @@
+import { useIntl } from 'react-intl';
+import { ReadableTimeProps } from './readable-time';
+/**
+ * Extending ReadableTimeProps with intl object.
+ */
+export interface GetReadableTimeArgs extends ReadableTimeProps {
+    /**
+     * Internationalization (intl) object for locale-based formatting.
+     */
+    intl: ReturnType<typeof useIntl>;
+}
+export interface GetReadableTime {
+    (args: GetReadableTimeArgs): string;
+}
+export declare function getReadableTime({ intl, timestamp, allowFutureTimestamps, alwaysShowTime, showWeekday, relativeThreshold, uppercase, }: GetReadableTimeArgs): string;

package/dist/types/lib/messages.d.ts

@@ -0,0 +1,33 @@
+declare const messages: {
+    eventTime: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    eventTimeToday: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    eventTimeYesterday: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    eventTimeDate: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    eventTimeDateShort: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    eventTimeWeekdayLong: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+};
+export default messages;

package/dist/types/lib/readable-time.d.ts

@@ -0,0 +1,39 @@
+import { TextProps } from '@box/blueprint-web';
+export interface ReadableTimeProps {
+    /**
+     * The timestamp to be used for displaying the date.
+     */
+    timestamp: number;
+    /**
+     * If true, future timestamps (typically caused by incorrect operating system time) will be corrected to show the 'isToday' message.
+     * @default true
+     */
+    allowFutureTimestamps?: boolean;
+    /**
+     * If true, the time will be displayed alongside the date (if the date is shown).
+     * @default false
+     */
+    alwaysShowTime?: boolean;
+    /**
+     * If true, the weekday will be displayed alongside the date (if the date is shown).
+     * @default false
+     */
+    showWeekday?: boolean;
+    /**
+     * The threshold (in milliseconds) before which a relative time (rather than an absolute time) will be shown.
+     * Default is 1 hour.
+     * @default ONE_HOUR_MS
+     */
+    relativeThreshold?: number;
+    /**
+     * If true, the generated string will be uppercase and locale-aware.
+     * @default false
+     */
+    uppercase?: boolean;
+    /**
+     * Props for the underlying Text component.
+     * @default {}
+     */
+    textProps?: TextProps;
+}
+export declare function ReadableTime({ timestamp, allowFutureTimestamps, alwaysShowTime, showWeekday, relativeThreshold, uppercase, textProps, }: ReadableTimeProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/stories/tests/story-grid.d.ts

@@ -0,0 +1,23 @@
+import { ReadableTimeProps } from '../../readable-time';
+interface StoryGridProps {
+    children: React.ReactNode;
+    rows: number;
+    columns: number;
+}
+export declare function StoryGrid({ children, rows, columns }: StoryGridProps): import("react/jsx-runtime").JSX.Element;
+interface Column {
+    name: string;
+    props?: Partial<ReadableTimeProps>;
+}
+interface HeaderProps {
+    columns: Column[];
+}
+export declare function Header({ columns }: HeaderProps): import("react/jsx-runtime").JSX.Element;
+interface RowProps {
+    now: number;
+    title: string;
+    offset: number;
+    columns: Column[];
+}
+export declare function Row({ now, title, offset, columns }: RowProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/lib/utils.d.ts

@@ -0,0 +1,10 @@
+interface TimeFromNowResult {
+    value: number;
+    unit: 'year' | 'week' | 'day' | 'hour' | 'minute' | 'second';
+}
+type DateValue = Date | number | string;
+export declare const isCurrentYear: (dateValue: DateValue) => boolean;
+export declare const isToday: (dateValue: DateValue) => boolean;
+export declare const isYesterday: (dateValue: DateValue) => boolean;
+export declare function timeFromNow(ms: number): TimeFromNowResult;
+export {};

package/package.json

@@ -0,0 +1,47 @@
+{
+    "name": "@box/readable-time",
+    "version": "1.39.52",
+    "license": "SEE LICENSE IN LICENSE",
+    "peerDependencies": {
+        "@box/blueprint-web": "^14.12.2",
+        "@box/blueprint-web-assets": "^4.114.3",
+        "react": "^18.0.0",
+        "react-dom": "^18.0.0",
+        "react-intl": "^6.4.2"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "devDependencies": {
+        "@box/blueprint-web": "^14.12.2",
+        "@box/blueprint-web-assets": "^4.114.3",
+        "@box/eslint-plugin-blueprint": "1.1.17",
+        "@box/storybook-utils": "0.17.45",
+        "react-intl": "^6.4.2"
+    },
+    "files": [
+        "dist"
+    ],
+    "main": "./dist/esm/index.js",
+    "module": "./dist/esm/index.js",
+    "types": "./dist/types/index.d.ts",
+    "exports": {
+        ".": {
+            "require": "./dist/esm/index.js",
+            "import": "./dist/esm/index.js",
+            "types": "./dist/types/index.d.ts"
+        },
+        "./*": {
+            "require": "./dist/esm/*",
+            "import": "./dist/esm/*",
+            "types": "./dist/types/*"
+        },
+        "./i18n/*": {
+            "require": "./dist/i18n/*",
+            "import": "./dist/i18n/*"
+        }
+    },
+    "sideEffects": [
+        "**/*.css"
+    ]
+}