@openmrs/esm-utils 4.0.0-pre.1 → 4.0.1-pre.208

package/jest.config.js

@@ -3,4 +3,7 @@ module.exports = {
     "^.+\\.tsx?$": ["@swc/jest"],
   },
   testEnvironment: "jsdom",
+  testEnvironmentOptions: {
+    url: "http://localhost/",
+  },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-utils",
-  "version": "4.0.0-pre.1",
+  "version": "4.0.1-pre.208",
   "license": "MPL-2.0",
   "description": "Helper utilities for OpenMRS",
   "browser": "dist/openmrs-esm-utils.js",
@@ -49,5 +49,5 @@
   "dependencies": {
     "semver": "^7.3.2"
   },
-  "gitHead": "9f58b801f07526083a9edc1cc5a1e58660d71eb0"
+  "gitHead": "7d28c0d3bdd2d73f38ceb04f4ca2c5b913158140"
 }

package/src/version.ts

@@ -27,5 +27,5 @@ export function isVersionSatisfied(
 
   return semver.satisfies(version, requiredVersion, {
     includePrerelease: true,
-  });
+  } as semver.Options);
 }

package/.turbo/turbo-lint.log

@@ -1,2 +0,0 @@
-@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 +0,0 @@
-@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 +0,0 @@
-@openmrs/esm-utils:typescript: cache hit, replaying output 7a618d75536aa1cc
-@openmrs/esm-utils:typescript: $ tsc

package/dist/age-helpers.d.ts

@@ -1,20 +0,0 @@
-/** @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

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

package/dist/omrs-dates.d.ts

@@ -1,110 +0,0 @@
-/**
- * @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

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

package/dist/retry.d.ts

@@ -1,38 +0,0 @@
-/** @module @category Utility */
-/**
- * Options for configuring the behavior of the {@link retry} function.
- */
-export interface RetryOptions {
-    /**
-     * Determines whether the retry function should retry executing the function after it failed
-     * with an error on the current attempt.
-     * @param attempt The current (zero-based) retry attempt. `0` indicates the initial attempt.
-     */
-    shouldRetry?(attempt: number): any;
-    /**
-     * Calculates the next delay (in milliseconds) before a retry attempt.
-     * Returning a value for the inital attempt (`0`) delays the initial function invocation.
-     * @param attempt The current (zero-based) retry attempt. `0` indicates the initial attempt.
-     */
-    getDelay?(attempt: number): number;
-    /**
-     * Called when invoking the function resulted in an error.
-     * Allows running side-effects on errors, e.g. logging.
-     * @param e The error thrown by the function.
-     * @param attempt The current (zero-based) retry attempt. `0` indicates the initial attempt.
-     */
-    onError?(e: any, attempt: number): void;
-}
-/**
- * Executes the specified function and retries executing on failure with a custom backoff strategy
- * defined by the options.
- *
- * If not configured otherwise, this function uses the following default options:
- * * Retries 5 times beyond the initial attempt.
- * * Uses an exponential backoff starting with an initial delay of 1000ms.
- * @param fn The function to be executed and retried on failure.
- * @param options Additional options which configure the retry behavior.
- * @returns The result of successfully executing `fn`.
- * @throws Rethrows the final error of running `fn` when the function stops retrying.
- */
-export declare function retry<T>(fn: () => Promise<T>, options?: RetryOptions): Promise<T>;

package/dist/translate.d.ts

@@ -1 +0,0 @@
-export declare function translateFrom(moduleName: string, key: string, fallback?: string, options?: object): string;

package/dist/version.d.ts

@@ -1 +0,0 @@
-export declare function isVersionSatisfied(requiredVersion: string, installedVersion: string): boolean;

package/dist/version.test.d.ts

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