@openmrs/esm-utils 4.0.0-pre.0 → 4.0.0-pre.1

package/.turbo/turbo-build.log

@@ -1,18 +1,18 @@
-@openmrs/esm-utils:build: cache hit, replaying output 5e20e7ebae69c0f9
-@openmrs/esm-utils:build: $ webpack --mode=production
-@openmrs/esm-utils:build: asset openmrs-esm-utils.js 47.2 KiB [emitted] [minimized] (name: main) 1 related asset
-@openmrs/esm-utils:build: runtime modules 2.02 KiB 7 modules
-@openmrs/esm-utils:build: orphan modules 18.9 KiB [orphan] 5 modules
-@openmrs/esm-utils:build: modules by path ../../../node_modules/semver/ 55.8 KiB 44 modules
-@openmrs/esm-utils:build: modules by path ../../../node_modules/systemjs-webpack-interop/ 3.27 KiB
-@openmrs/esm-utils:build:   ../../../node_modules/systemjs-webpack-interop/auto-public-path/1.js 89 bytes [built] [code generated]
-@openmrs/esm-utils:build:   ../../../node_modules/systemjs-webpack-interop/auto-public-path/auto-public-path.js 846 bytes [built] [code generated]
-@openmrs/esm-utils:build:   ../../../node_modules/systemjs-webpack-interop/public-path.js 2.36 KiB [built] [code generated]
-@openmrs/esm-utils:build: modules by path ../../../node_modules/dayjs/plugin/*.js 2.56 KiB
-@openmrs/esm-utils:build:   ../../../node_modules/dayjs/plugin/utc.js 2.2 KiB [built] [code generated]
-@openmrs/esm-utils:build:   ../../../node_modules/dayjs/plugin/isToday.js 365 bytes [built] [code generated]
-@openmrs/esm-utils:build: modules by path ../../../node_modules/yallist/*.js 8.42 KiB
-@openmrs/esm-utils:build:   ../../../node_modules/yallist/yallist.js 8.21 KiB [built] [code generated]
-@openmrs/esm-utils:build:   ../../../node_modules/yallist/iterator.js 207 bytes [built] [code generated]
-@openmrs/esm-utils:build: + 5 modules
-@openmrs/esm-utils:build: webpack 5.70.0 compiled successfully in 6749 ms
+@openmrs/esm-utils:build: cache hit, replaying output 96a8c5c50f754983
+@openmrs/esm-utils:build: $ webpack --mode=production
+@openmrs/esm-utils:build: asset openmrs-esm-utils.js 47.2 KiB [emitted] [minimized] (name: main) 1 related asset
+@openmrs/esm-utils:build: runtime modules 2.02 KiB 7 modules
+@openmrs/esm-utils:build: orphan modules 19 KiB [orphan] 5 modules
+@openmrs/esm-utils:build: modules by path ../../../node_modules/semver/ 55.8 KiB 44 modules
+@openmrs/esm-utils:build: modules by path ../../../node_modules/systemjs-webpack-interop/ 3.27 KiB
+@openmrs/esm-utils:build:   ../../../node_modules/systemjs-webpack-interop/auto-public-path/1.js 89 bytes [built] [code generated]
+@openmrs/esm-utils:build:   ../../../node_modules/systemjs-webpack-interop/auto-public-path/auto-public-path.js 846 bytes [built] [code generated]
+@openmrs/esm-utils:build:   ../../../node_modules/systemjs-webpack-interop/public-path.js 2.36 KiB [built] [code generated]
+@openmrs/esm-utils:build: modules by path ../../../node_modules/dayjs/plugin/*.js 2.56 KiB
+@openmrs/esm-utils:build:   ../../../node_modules/dayjs/plugin/utc.js 2.2 KiB [built] [code generated]
+@openmrs/esm-utils:build:   ../../../node_modules/dayjs/plugin/isToday.js 365 bytes [built] [code generated]
+@openmrs/esm-utils:build: modules by path ../../../node_modules/yallist/*.js 8.42 KiB
+@openmrs/esm-utils:build:   ../../../node_modules/yallist/yallist.js 8.21 KiB [built] [code generated]
+@openmrs/esm-utils:build:   ../../../node_modules/yallist/iterator.js 207 bytes [built] [code generated]
+@openmrs/esm-utils:build: + 5 modules
+@openmrs/esm-utils:build: webpack 5.70.0 compiled successfully in 22478 ms

package/.turbo/turbo-lint.log

@@ -1,2 +1,2 @@
-@openmrs/esm-utils:lint: cache hit, replaying output 5f2c624ca5cde50d
+@openmrs/esm-utils:lint: cache hit, replaying output 9f58a5aad569522c
 @openmrs/esm-utils:lint: $ eslint src --ext ts,tsx

package/.turbo/turbo-test.log

@@ -1,10 +1,10 @@
-@openmrs/esm-utils:test: cache hit, replaying output c0c99dbb97300d6e
-@openmrs/esm-utils:test: $ jest --config jest.config.js --passWithNoTests
-@openmrs/esm-utils:test: PASS src/version.test.ts
-@openmrs/esm-utils:test: PASS src/omrs-dates.test.ts
-@openmrs/esm-utils:test: 
-@openmrs/esm-utils:test: Test Suites: 2 passed, 2 total
-@openmrs/esm-utils:test: Tests:       22 passed, 22 total
-@openmrs/esm-utils:test: Snapshots:   0 total
-@openmrs/esm-utils:test: Time:        7.97 s
-@openmrs/esm-utils:test: Ran all test suites.
+@openmrs/esm-utils:test: cache hit, replaying output cf5960bce80c784e
+@openmrs/esm-utils:test: $ jest --config jest.config.js --passWithNoTests
+@openmrs/esm-utils:test: PASS src/omrs-dates.test.ts
+@openmrs/esm-utils:test: PASS src/version.test.ts
+@openmrs/esm-utils:test: 
+@openmrs/esm-utils:test: Test Suites: 2 passed, 2 total
+@openmrs/esm-utils:test: Tests:       22 passed, 22 total
+@openmrs/esm-utils:test: Snapshots:   0 total
+@openmrs/esm-utils:test: Time:        5.794 s
+@openmrs/esm-utils:test: Ran all test suites.

package/.turbo/turbo-typescript.log

@@ -1,2 +1,2 @@
-@openmrs/esm-utils:typescript: cache hit, replaying output 5cdb80788a2384dc
-@openmrs/esm-utils:typescript: $ tsc
+@openmrs/esm-utils:typescript: cache hit, replaying output 7a618d75536aa1cc
+@openmrs/esm-utils:typescript: $ tsc

package/dist/age-helpers.d.ts

@@ -0,0 +1,20 @@
+/** @module @category Utility */
+/**
+ * Gets the number of days in the year of the given date.
+ * @param date The date to compute the days within the year.
+ * @returns The number of days.
+ */
+export declare function daysIntoYear(date: Date): number;
+/**
+ * Checks if two dates are representing the same day.
+ * @param firstDate The first date.
+ * @param secondDate The second date.
+ * @returns True if both are located on the same day.
+ */
+export declare function isSameDay(firstDate: Date, secondDate: Date): boolean;
+/**
+ * Gets a human readable age represention of the provided date string.
+ * @param dateString The stringified date.
+ * @returns A human-readable string version of the age.
+ */
+export declare function age(dateString: string): string;

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./age-helpers";
+export * from "./omrs-dates";
+export * from "./translate";
+export * from "./version";
+export * from "./retry";

package/dist/omrs-dates.d.ts

@@ -0,0 +1,110 @@
+/**
+ * @module
+ * @category Date and Time
+ */
+import { i18n } from "i18next";
+declare global {
+    interface Window {
+        i18next: i18n;
+    }
+}
+export declare type DateInput = string | number | Date;
+/**
+ * This function is STRICT on checking whether a date string is the openmrs format.
+ * The format should be YYYY-MM-DDTHH:mm:ss.SSSZZ
+ */
+export declare function isOmrsDateStrict(omrsPayloadString: string): boolean;
+/**
+ *
+ * @param date Checks if the provided date is today.
+ */
+export declare function isOmrsDateToday(date: DateInput): boolean;
+/**
+ * Converts the object to a date object if it is a valid ISO date time string.
+ */
+export declare function toDateObjectStrict(omrsDateString: string): Date | null;
+/**
+ * Formats the input as a date time string using the format "YYYY-MM-DDTHH:mm:ss.SSSZZ".
+ */
+export declare function toOmrsIsoString(date: DateInput, toUTC?: boolean): string;
+/**
+ * @deprecated use `formatTime`
+ * Formats the input as a time string using the format "HH:mm".
+ */
+export declare function toOmrsTimeString24(date: DateInput): string;
+/**
+ * @deprecated use `formatTime`
+ * Formats the input as a time string using the format "HH:mm A".
+ */
+export declare function toOmrsTimeString(date: DateInput): string;
+/**
+ * @deprecated use `formatDate(date, "wide")`
+ * Formats the input as a date string using the format "DD - MMM - YYYY".
+ */
+export declare function toOmrsDayDateFormat(date: DateInput): string;
+/**
+ * @deprecated use `formatDate(date, "no year")`
+ * Formats the input as a date string using the format "DD-MMM".
+ */
+export declare function toOmrsYearlessDateFormat(date: DateInput): string;
+/**
+ * @deprecated use `formatDate(date)`
+ * Formats the input as a date string. By default the format "YYYY-MMM-DD" is used.
+ */
+export declare function toOmrsDateFormat(date: DateInput, format?: string): string;
+/**
+ * Utility function to parse an arbitrary string into a date.
+ * Uses `dayjs(dateString)`.
+ */
+export declare function parseDate(dateString: string): Date;
+export declare type FormatDateMode = "standard" | "wide";
+export declare type FormatDateOptions = {
+    /**
+     * - `standard`: "03 Feb 2022"
+     * - `wide`:     "03 — Feb — 2022"
+     */
+    mode: FormatDateMode;
+    /**
+     * Whether the time should be included in the output always (`true`),
+     * never (`false`), or only when the input date is today (`for today`).
+     */
+    time: true | false | "for today";
+    /** Whether to include the day number */
+    day: boolean;
+    /** Whether to include the year */
+    year: boolean;
+};
+/**
+ * Formats the input date according to the current locale and the
+ * given options.
+ *
+ * Default options:
+ *  - mode: "standard",
+ *  - time: "for today",
+ *  - day: true,
+ *  - year: true
+ *
+ * If the date is today then "Today" is produced (in the locale language).
+ *
+ * When time is included, it is appended with a comma and a space. This
+ * agrees with the output of `Date.prototype.toLocaleString` for *most*
+ * locales.
+ *
+ * TODO: Shouldn't throw on null input
+ */
+export declare function formatDate(date: Date, options?: Partial<FormatDateOptions>): string;
+/**
+ * Formats the input as a time, according to the current locale.
+ * 12-hour or 24-hour clock depends on locale.
+ */
+export declare function formatTime(date: Date): string;
+/**
+ * Formats the input into a string showing the date and time, according
+ * to the current locale. The `mode` parameter is as described for
+ * `formatDate`.
+ *
+ * This is created by concatenating the results of `formatDate`
+ * and `formatTime` with a comma and space. This agrees with the
+ * output of `Date.prototype.toLocaleString` for *most* locales.
+ */
+export declare function formatDatetime(date: Date, options?: Partial<Omit<FormatDateOptions, "time">>): string;

package/dist/omrs-dates.test.d.ts

@@ -0,0 +1 @@
+export {};