@bigbinary/neeto-commons-frontend 2.1.5 → 2.1.7

package/utils.d.ts

@@ -4,11 +4,15 @@ import React from "react";
 export function resetAuthTokens(): void;
 /**
  *
- * Curried: true
+ * The withEventTargetValue function is a curried function that accepts a
  *
- * It is a curried function that accepts a function as the first parameter and an
+ * function as its first parameter and an event object as its second parameter. It
  *
- * event as the second, and executes the given function with event.target.value
+ * executes the given function with the event.target.value as an argument, making
+ *
+ * it easier to extract and work with the value of form inputs or other elements
+ *
+ * that trigger events.
  *
  * @example 
  *
@@ -22,11 +26,15 @@ export function resetAuthTokens(): void;
 export function withEventTargetValue(func: (value: string) => void, event: React.ChangeEvent): void;
 /**
  *
- * Curried: true
+ * The withEventTargetValue function is a curried function that accepts a
+ *
+ * function as its first parameter and an event object as its second parameter. It
  *
- * It is a curried function that accepts a function as the first parameter and an
+ * executes the given function with the event.target.value as an argument, making
  *
- * event as the second, and executes the given function with event.target.value
+ * it easier to extract and work with the value of form inputs or other elements
+ *
+ * that trigger events.
  *
  * @example 
  *
@@ -40,9 +48,11 @@ export function withEventTargetValue(func: (value: string) => void, event: React
 export function withEventTargetValue(func: (value: string) => void): React.ChangeEventHandler;
 /**
  *
- * Curried: false
+ * The getSubdomain function retrieves the subdomain of the current URL and
+ *
+ * returns it as a string. A subdomain is a prefix that appears before the main
  *
- * This function returns the subdomain of the current URL.
+ * domain name in a URL.
  *
  * @example 
  *
@@ -55,13 +65,13 @@ export function withEventTargetValue(func: (value: string) => void): React.Chang
 export function getSubdomain(): string;
 /**
  *
- * Curried: false
+ * The simulateApiCall function simulates an API call and returns a response
  *
- * This function will simulate an API call and retrieve the hardcoded success/error
+ * object with a specified delay. This function is useful during frontend
  *
- * responses after some delay based on the given error probability. This function
+ * development when you need to mock API calls before the backend is fully
  *
- * is helpful when we are building the frontend before the backend is ready.
+ * implemented.
  *
  * @example 
  *
@@ -71,9 +81,11 @@ export function getSubdomain(): string;
 export function simulateApiCall<T>(result: T, error?: any, errorProbability?: number, delayMs?: number): Promise<T>;
 /**
  *
- * Curried: false
+ * The copyToClipboard function copies the given string to the clipboard and
+ *
+ * displays a success message, typically a toaster notification, to indicate that
  *
- * Copies the given string to clipboard and shows a success toaster message.
+ * the operation was successful.
  *
  * @example 
  *
@@ -91,13 +103,15 @@ export function copyToClipboard(text: string, configs?: {
 }): void;
 /**
  *
- * Curried: false
+ * The buildUrl function builds a URL by inflating a route-like template string
  *
- * Builds a URL by inflating route like template string (example:
+ * (e.g., /products/:productId/variants/:id) using the provided parameters. It
  *
- * /products/:productId/variants/:id) using the given params. Any extra
+ * allows you to create URLs dynamically based on a template and replace
  *
- * properties in the params will be attached as query parameters to the URL.
+ * placeholders with actual values. Any additional properties in the parameters
+ *
+ * will be attached as query parameters to the URL.
  *
  * @example 
  *
@@ -129,19 +143,86 @@ export const timeFormat: {
   dateWeekTimeDayExtended: (time: DateTimeType) => string;
   extended: (time: DateTimeType) => string;
   default: (time: DateTimeType) => string;
+  defaultWithTime: (time: DateTimeType) => string;
 };
+/**
+ *
+ * The dateFormat and timeFormat functions are aliases of each other, and they
+ *
+ * are used for formatting dates and times in various ways. These functions provide
+ *
+ * a convenient way to format date and time values according to specific patterns
+ *
+ * and display them in a human-readable format.
+ *
+ * @example 
+ *
+ * const sourceDate = "2020-01-01T00:00:00.000Z"; // can be anything that dayjs can parse
+ * 
+ * dateFormat.fromNow(date); // "3 years ago"
+ * timeFormat.fromNow(date); // "3 years ago"
+ * 
+ * dateFormat.time(date); // "12:00 AM"
+ * timeFormat.time(date); // "12:00 AM"
+ * 
+ * dateFormat.timeWithSeconds(date); // "12:00:00 AM"
+ * timeFormat.timeWithSeconds(date); // "12:00:00 AM"
+ * 
+ * dateFormat.date(date); // "Jan 1, 2020"
+ * timeFormat.date(date); // "Jan 1, 2020"
+ * 
+ * dateFormat.dateWeek(date); // "Jan 1, 2020 Wed"
+ * timeFormat.dateWeek(date); // "Jan 1, 2020 Wed"
+ * 
+ * dateFormat.dateWeekDayExtended(date); // "Jan 1, 2020 Wednesday"
+ * timeFormat.dateWeekDayExtended(date); // "Jan 1, 2020 Wednesday"
+ * 
+ * dateFormat.dateWeekWithoutYear(date); // "Jan 1, Wed"
+ * timeFormat.dateWeekWithoutYear(date); // "Jan 1, Wed"
+ * 
+ * dateFormat.dateWeekWithoutYearDayExtended(date); // "Jan 1, Wednesday"
+ * timeFormat.dateWeekWithoutYearDayExtended(date); // "Jan 1, Wednesday"
+ * 
+ * dateFormat.dateTime(date); // "Jan 1, 2020 12:00 AM"
+ * timeFormat.dateTime(date); // "Jan 1, 2020 12:00 AM"
+ * 
+ * dateFormat.dateTimeWithSeconds(date); // "Jan 1, 2020 12:00:00 AM"
+ * timeFormat.dateTimeWithSeconds(date); // "Jan 1, 2020 12:00:00 AM"
+ * 
+ * dateFormat.dateWeekTime(date); // "Jan 1, 2020 Wed 12:00 AM"
+ * timeFormat.dateWeekTime(date); // "Jan 1, 2020 Wed 12:00 AM"
+ * 
+ * dateFormat.dateWeekTimeDayExtended(date); // "Jan 1, 2020 Wednesday 12:00 AM"
+ * timeFormat.dateWeekTimeDayExtended(date); // "Jan 1, 2020 Wednesday 12:00 AM"
+ * 
+ * dateFormat.extended(date); // "Wednesday January 1, 2020 12:00 AM (3 years ago)"
+ * timeFormat.extended(date); // "Wednesday January 1, 2020 12:00 AM (3 years ago)"
+ * 
+ * dateFormat.default(date); // This will return date in user date format in globalProps
+ * timeFormat.default(date); // This will return date in user date format in globalProps
+ * 
+ * dateFormat.defaultWithTime(date); // This will return date time in user date format in globalProps
+ * timeFormat.defaultWithTime(date); // This will return date time in user date format in globalProps
+ * @endexample
+ * All neeto-applications should be using any one of these styles (according to the
+ *
+ * space available) to display date and time unless if the case is too specific to
+ *
+ * the project.
+ *
+*/
 export const dateFormat: typeof timeFormat;
 /**
  *
- * Curried: false
+ * The toLocale function converts a given number to a locale-specific string
  *
- * Converts the given number to a locale string (converts to a comma separated
+ * representation, formatting it with commas as thousands separators and respecting
  *
- * string). It automatically identifies the locale using globalProps. If a valid
+ * the appropriate decimal separator for the locale. It automatically detects the
  *
- * value isn't present in globalProps, it will rely on the current browser's
+ * appropriate locale using globalProps and falls back to the user's browser
  *
- * locale.
+ * locale if necessary.
  *
  * @example 
  *
@@ -178,9 +259,13 @@ type QueryParamsType = {
 };
 /**
  *
- * Curried: false
+ * The getQueryParams function retrieves all the query parameters from the
+ *
+ * current URL and returns them as an object. Query parameters are typically found
+ *
+ * in the URL following a "?" character and are used to pass data to a web page or
  *
- * This function returns all the query parameters of the current URL as an object.
+ * API.
  *
  * @example 
  *
@@ -193,9 +278,9 @@ type QueryParamsType = {
 export function getQueryParams(options?: qsOptionsType): QueryParamsType;
 /**
  *
- * Curried: false
+ * The joinHyphenCase function joins an array of strings using hyphens as the
  *
- * This function joins the given strings with hyphen.
+ * delimiter and returns the resulting string.
  *
  * Any number of string arguments.
  *
@@ -207,11 +292,11 @@ export function getQueryParams(options?: qsOptionsType): QueryParamsType;
 export function joinHyphenCase(...args: string[]): string;
 /**
  *
- * Curried: false
+ * The debounce function is used to create a debounced function that delays the
  *
- * Creates a debounced function that will execute the given function after the
+ * execution of a given function until a specified wait time, in milliseconds, has
  *
- * stated wait time in milliseconds has elapsed since the last time it was invoked.
+ * elapsed since the last time it was invoked.
  *
  * @example 
  *
@@ -226,9 +311,15 @@ export function joinHyphenCase(...args: string[]): string;
 export function debounce<F extends Function>(func: F, delay?: number): F;
 /**
  *
- * Curried: false
+ * The hasPermission function checks whether the current user has a specific
+ *
+ * permission. It returns true if the user has the specified permission and
+ *
+ * false if they do not. Permissions are typically used to control access to
+ *
+ * various features or actions within an application. The permissions corresponding
  *
- * This function will return true if the current user has the given permission.
+ * to a particular user is taken from the globalProps.
  *
  * @example 
  *
@@ -238,11 +329,13 @@ export function debounce<F extends Function>(func: F, delay?: number): F;
 export function hasPermission(permission: string): boolean;
 /**
  *
- * Curried: false
+ * The hasAnyPermission function checks whether the current user has any of the
  *
- * This function will return true if the current user has any of the given
+ * specified permissions. It returns true if the user has at least one of the
  *
- * permissions.
+ * permissions and false if the user has none of them. The permissions
+ *
+ * corresponding to a particular user is taken from the globalProps.
  *
  * permissions: Any number of permission strings.
  *
@@ -254,11 +347,13 @@ export function hasPermission(permission: string): boolean;
 export function hasAnyPermission(...permissions: string[]): boolean;
 /**
  *
- * Curried: false
+ * The hasAllPermissions function checks whether the current user has all of the
+ *
+ * specified permissions. It returns true if the user has all the permissions and
  *
- * This function will return true if the current user has all of the given
+ * false otherwise. The permissions corresponding to a particular user is taken
  *
- * permissions.
+ * from the globalProps.
  *
  * permissions: Any number of permission strings.
  *
@@ -274,11 +369,15 @@ type ChannelNameWithParams = {
 };
 /**
  *
- * Curried: false
+ * The createSubscription function is used to create a subscription in a web
+ *
+ * application where a consumer subscribes to a Rails
  *
- * This function will create subscription where consumer is subscribed to rails
+ * Action Cable
  *
- * action cable channel.
+ * channel. This function facilitates the creation of subscriptions on the client
+ *
+ * side to listen for updates and events broadcasted on a specific channel.
  *
  * @example 
  *
@@ -294,11 +393,13 @@ type ChannelNameWithParams = {
 export function createSubscription(channelName: string | ChannelNameWithParams, callbacks: Mixin): Subscription;
 /**
  *
- * Curried: false
+ * The getFromLocalStorage function retrieves a JSON-parsed value from the
+ *
+ * browser's localStorage for the specified key. If the stored value is not valid
  *
- * This function returns JSON parsed value from localStorage for the given key. The
+ * JSON or if the key does not exist in localStorage, the function returns
  *
- * function returns null if the value is not valid JSON.
+ * null.
  *
  * @example 
  *

package/utils.js

@@ -2648,6 +2648,10 @@ var getFromLocalStorage = function getFromLocalStorage(key) {
 
 dayjs.extend(relativeTime);
 dayjs.extend(updateLocale);
+var getDefaultFormat = function getDefaultFormat() {
+  var _globalProps$user$dat, _globalProps, _globalProps$user;
+  return (_globalProps$user$dat = (_globalProps = globalProps) === null || _globalProps === void 0 ? void 0 : (_globalProps$user = _globalProps.user) === null || _globalProps$user === void 0 ? void 0 : _globalProps$user.dateFormat) !== null && _globalProps$user$dat !== void 0 ? _globalProps$user$dat : "DD/MM/YYYY";
+};
 var timeFormat = {
   fromNow: function fromNow(time) {
     return dayjs(time).fromNow();
@@ -2691,8 +2695,10 @@ var timeFormat = {
     return "".concat(dateTime, " (").concat(fromNow, ")");
   },
   "default": function _default(time) {
-    var _globalProps$user$dat, _globalProps, _globalProps$user;
-    return dayjs(time).format((_globalProps$user$dat = (_globalProps = globalProps) === null || _globalProps === void 0 ? void 0 : (_globalProps$user = _globalProps.user) === null || _globalProps$user === void 0 ? void 0 : _globalProps$user.dateFormat) !== null && _globalProps$user$dat !== void 0 ? _globalProps$user$dat : "DD/MM/YYYY");
+    return dayjs(time).format(getDefaultFormat());
+  },
+  defaultWithTime: function defaultWithTime(time) {
+    return dayjs(time).format("".concat(getDefaultFormat(), " hh:mm:ss A"));
   }
 };
 var dateFormat = timeFormat;