atomic-fns 0.3.2 → 0.3.3

package/core/collections/index.d.ts

@@ -107,6 +107,15 @@ findRight([1, 2, 3, 4], (n) => n % 2 === 1)
  * @see {@link find}
  */
 export declare function findRight(arr: any, fn: Iteratee | PropertyKey | Object): any;
+/**
+ * Performs an efficient array insert operation in the given array. If the index or the array is invalid, it just returns the given array.
+ *
+ * @param {Array<*>} arr The given array to insert into
+ * @param {number} index The index of the array insert operation.
+ * @param {*} value The value to insert in the array at the given `index`.
+ * @returns {Array<*>} The given array.
+ */
+export declare function insert(arr: any[], index: number, value: any): any[];
 /**
  * Creates a function that performs a partial deep comparison between a given object and `shape`, returning `true` if the given object has equivalent property values, else `false`.
  * @example
@@ -501,7 +510,7 @@ export declare function union(...args: Array<Iterable<any>>): Generator<unknown,
  *
  * @param arr The collection to iterate over.
  * @param [func=id] The iteratee to transform keys.
- * @returns Returns the composed aggregate object.
+ * @returns Returns the aggregated object.
  *
  * @example
 ```js
@@ -514,6 +523,25 @@ groupBy(['one', 'two', 'three'], 'length')
 ```
  */
 export declare function groupBy(arr: Iterable<any> | Object, func?: Iteratee | PropertyKey): Object;
+/**
+ * Similar to {@link groupBy} but it returns a {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map Map} object with the results.
+ *
+ * @param arr The collection to iterate over.
+ * @param {Function | PropertyKey} [func=id] The iteratee to transform keys.
+ * @returns {Map} Returns the aggregated map object.
+ * @template K, V
+ *
+ * @example
+```js
+groupByMap([6.1, 4.2, 6.3], Math.floor)
+// => Map { 4: [4.2], 6: [6.1, 6.3] }
+
+// The `property` iteratee shorthand.
+groupByMap(['one', 'two', 'three'], 'length')
+// => Map { 3: ['one', 'two'], 5: ['three'] }
+```
+ */
+export declare function groupByMap<K = any, V = any>(arr: Iterable<any> | Object, func?: Iteratee | PropertyKey): Map<K, V[]>;
 /**
  * Removes all elements from array that `func` returns truthy for and returns an array of the removed elements.
  * @param arr The array to remove from.

package/core/collections/index.js

@@ -156,6 +156,20 @@ export function findRight(arr, fn) {
         }
     }
 }
+/**
+ * Performs an efficient array insert operation in the given array. If the index or the array is invalid, it just returns the given array.
+ *
+ * @param {Array<*>} arr The given array to insert into
+ * @param {number} index The index of the array insert operation.
+ * @param {*} value The value to insert in the array at the given `index`.
+ * @returns {Array<*>} The given array.
+ */
+export function insert(arr, index, value) {
+    if (!arr || arr.length <= index || index < 0)
+        return arr;
+    arr.splice(index, 0, value);
+    return arr;
+}
 /**
  * Creates a function that performs a partial deep comparison between a given object and `shape`, returning `true` if the given object has equivalent property values, else `false`.
  * @example
@@ -898,7 +912,7 @@ export function* union(...args) {
  *
  * @param arr The collection to iterate over.
  * @param [func=id] The iteratee to transform keys.
- * @returns Returns the composed aggregate object.
+ * @returns Returns the aggregated object.
  *
  * @example
 ```js
@@ -921,6 +935,35 @@ export function groupBy(arr, func = id) {
     });
     return results;
 }
+/**
+ * Similar to {@link groupBy} but it returns a {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map Map} object with the results.
+ *
+ * @param arr The collection to iterate over.
+ * @param {Function | PropertyKey} [func=id] The iteratee to transform keys.
+ * @returns {Map} Returns the aggregated map object.
+ * @template K, V
+ *
+ * @example
+```js
+groupByMap([6.1, 4.2, 6.3], Math.floor)
+// => Map { 4: [4.2], 6: [6.1, 6.3] }
+
+// The `property` iteratee shorthand.
+groupByMap(['one', 'two', 'three'], 'length')
+// => Map { 3: ['one', 'two'], 5: ['three'] }
+```
+ */
+export function groupByMap(arr, func = id) {
+    const results = new Map();
+    const useKey = typeof func === 'function' ? func : partial(get, func);
+    forEach(arr, (value) => {
+        const groupKey = useKey(value);
+        const values = results.get(groupKey) || [];
+        values.push(value);
+        results.set(groupKey, values);
+    });
+    return results;
+}
 /**
  * Removes all elements from array that `func` returns truthy for and returns an array of the removed elements.
  * @param arr The array to remove from.

package/core/collections/index.ts

@@ -180,6 +180,20 @@ export function findRight(arr, fn: Iteratee | PropertyKey | Object) {
   }
 }
 
+/**
+ * Performs an efficient array insert operation in the given array. If the index or the array is invalid, it just returns the given array.
+ *
+ * @param {Array<*>} arr The given array to insert into
+ * @param {number} index The index of the array insert operation.
+ * @param {*} value The value to insert in the array at the given `index`.
+ * @returns {Array<*>} The given array.
+ */
+export function insert(arr: any[], index: number, value) {
+  if (!arr || arr.length <= index || index < 0) return arr
+  arr.splice(index, 0, value)
+  return arr
+}
+
 /**
  * Creates a function that performs a partial deep comparison between a given object and `shape`, returning `true` if the given object has equivalent property values, else `false`.
  * @example
@@ -933,7 +947,7 @@ export function* union(...args: Array<Iterable<any>>) {
  *
  * @param arr The collection to iterate over.
  * @param [func=id] The iteratee to transform keys.
- * @returns Returns the composed aggregate object.
+ * @returns Returns the aggregated object.
  *
  * @example
 ```js
@@ -957,6 +971,39 @@ export function groupBy(arr: Iterable<any> | Object, func: Iteratee | PropertyKe
   return results
 }
 
+/**
+ * Similar to {@link groupBy} but it returns a {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map Map} object with the results.
+ *
+ * @param arr The collection to iterate over.
+ * @param {Function | PropertyKey} [func=id] The iteratee to transform keys.
+ * @returns {Map} Returns the aggregated map object.
+ * @template K, V
+ *
+ * @example
+```js
+groupByMap([6.1, 4.2, 6.3], Math.floor)
+// => Map { 4: [4.2], 6: [6.1, 6.3] }
+
+// The `property` iteratee shorthand.
+groupByMap(['one', 'two', 'three'], 'length')
+// => Map { 3: ['one', 'two'], 5: ['three'] }
+```
+ */
+export function groupByMap<K = any, V = any>(
+  arr: Iterable<any> | Object,
+  func: Iteratee | PropertyKey = id
+): Map<K, V[]> {
+  const results = new Map<K, V[]>()
+  const useKey = typeof func === 'function' ? func : partial(get, func)
+  forEach(arr, (value: V) => {
+    const groupKey = useKey(value)
+    const values = results.get(groupKey) || []
+    values.push(value)
+    results.set(groupKey, values)
+  })
+  return results
+}
+
 /**
  * Removes all elements from array that `func` returns truthy for and returns an array of the removed elements.
  * @param arr The array to remove from.

package/core/datetime/index.d.ts

@@ -3,4 +3,43 @@
  *
  * @module Date
  */
+export declare const MINUTE_SECONDS = 60;
+export declare const HOUR_SECONDS: number;
+export declare const DAY_SECONDS: number;
+export declare const WEEK_SECONDS: number;
+export declare const MILLISECONDS = 1000;
+export declare const MINUTE_MILLISECONDS: number;
+export declare const HOUR_MILLISECONDS: number;
+export declare const DAY_MILLISECONDS: number;
+export declare const WEEK_MILLISECONDS: number;
+export declare const MS = "millisecond";
+export declare const S = "second";
+export declare const MIN = "minute";
+export declare const H = "hour";
+export declare const D = "day";
+export declare const W = "week";
+export declare const M = "month";
+export declare const Q = "quarter";
+export declare const Y = "year";
+export declare const DATE = "date";
+export declare const FORMAT_DEFAULT = "YYYY-MM-DDTHH:mm:ssZ";
+export declare const INVALID_DATE_STRING = "Invalid Date";
+export declare const REGEX_PARSE: RegExp;
+export declare const REGEX_FORMAT: RegExp;
 export declare const now: number;
+export declare type DatetimeOptions = {
+    year: number;
+    month?: number;
+    day?: number;
+    hour?: number;
+    minute?: number;
+    second?: number;
+    millisecond?: number;
+    locale?: string;
+    utc?: boolean;
+};
+export declare class Datetime {
+    #private;
+    constructor(opts?: string | number | Date | DatetimeOptions);
+    format(locale?: string, opts?: Intl.DateTimeFormatOptions): string;
+}

package/core/datetime/index.js

@@ -3,4 +3,69 @@
  *
  * @module Date
  */
+import { get } from '../globals';
+// Constants
+export const MINUTE_SECONDS = 60;
+export const HOUR_SECONDS = MINUTE_SECONDS * 60;
+export const DAY_SECONDS = HOUR_SECONDS * 24;
+export const WEEK_SECONDS = DAY_SECONDS * 7;
+export const MILLISECONDS = 1e3;
+export const MINUTE_MILLISECONDS = MINUTE_SECONDS * MILLISECONDS;
+export const HOUR_MILLISECONDS = HOUR_SECONDS * MILLISECONDS;
+export const DAY_MILLISECONDS = DAY_SECONDS * MILLISECONDS;
+export const WEEK_MILLISECONDS = WEEK_SECONDS * MILLISECONDS;
+// English locales
+export const MS = 'millisecond';
+export const S = 'second';
+export const MIN = 'minute';
+export const H = 'hour';
+export const D = 'day';
+export const W = 'week';
+export const M = 'month';
+export const Q = 'quarter';
+export const Y = 'year';
+export const DATE = 'date';
+export const FORMAT_DEFAULT = 'YYYY-MM-DDTHH:mm:ssZ';
+export const INVALID_DATE_STRING = 'Invalid Date';
+// regex
+export const REGEX_PARSE = /^(\d{4})[-/]?(\d{1,2})?[-/]?(\d{0,2})[Tt\s]*(\d{1,2})?:?(\d{1,2})?:?(\d{1,2})?[.:]?(\d+)?$/;
+export const REGEX_FORMAT = /\[([^\]]+)]|Y{1,4}|M{1,4}|D{1,2}|d{1,4}|H{1,2}|h{1,2}|a|A|m{1,2}|s{1,2}|Z{1,2}|SSS/g;
 export const now = new Date().getTime();
+function parseDate(date) {
+    if (date === null)
+        return new Date(NaN);
+    if (!date)
+        return new Date();
+    if (date instanceof Date)
+        return new Date(date);
+    const utc = date.utc;
+    if (typeof date === 'string' && !/Z$/i.test(date)) {
+        const d = date.match(REGEX_PARSE);
+        if (d) {
+            const m = d[2] - 1 || 0;
+            const ms = (d[7] || '0').slice(0, 3);
+            if (utc) {
+                return new Date(Date.UTC(d[1], m, d[3] || 1, d[4] || 0, d[5] || 0, d[6] || 0, ms));
+            }
+            return new Date(d[1], m, d[3] || 1, d[4] || 0, d[5] || 0, d[6] || 0, ms);
+        }
+    }
+    return new Date(date);
+}
+export class Datetime {
+    #date = new Date(); // defaults to now
+    #UTC = false; // use current locale by default
+    constructor(opts) {
+        this.#date = parseDate(opts);
+        this.#UTC = get('utc', opts, false);
+        // this.init()
+    }
+    // Display
+    // Format
+    format(locale, opts) {
+        if (opts && opts.timeZone === undefined && this.#UTC) {
+            opts.timeZone = 'utc';
+        }
+        return this.#date.toLocaleDateString(locale, opts);
+    }
+}

package/core/datetime/index.ts

@@ -4,4 +4,125 @@
  * @module Date
  */
 
+import { get } from '../globals'
+
+// Constants
+export const MINUTE_SECONDS = 60
+export const HOUR_SECONDS = MINUTE_SECONDS * 60
+export const DAY_SECONDS = HOUR_SECONDS * 24
+export const WEEK_SECONDS = DAY_SECONDS * 7
+
+export const MILLISECONDS = 1e3
+export const MINUTE_MILLISECONDS = MINUTE_SECONDS * MILLISECONDS
+export const HOUR_MILLISECONDS = HOUR_SECONDS * MILLISECONDS
+export const DAY_MILLISECONDS = DAY_SECONDS * MILLISECONDS
+export const WEEK_MILLISECONDS = WEEK_SECONDS * MILLISECONDS
+
+// English locales
+export const MS = 'millisecond'
+export const S = 'second'
+export const MIN = 'minute'
+export const H = 'hour'
+export const D = 'day'
+export const W = 'week'
+export const M = 'month'
+export const Q = 'quarter'
+export const Y = 'year'
+export const DATE = 'date'
+
+export const FORMAT_DEFAULT = 'YYYY-MM-DDTHH:mm:ssZ'
+
+export const INVALID_DATE_STRING = 'Invalid Date'
+
+// regex
+export const REGEX_PARSE =
+  /^(\d{4})[-/]?(\d{1,2})?[-/]?(\d{0,2})[Tt\s]*(\d{1,2})?:?(\d{1,2})?:?(\d{1,2})?[.:]?(\d+)?$/
+export const REGEX_FORMAT =
+  /\[([^\]]+)]|Y{1,4}|M{1,4}|D{1,2}|d{1,4}|H{1,2}|h{1,2}|a|A|m{1,2}|s{1,2}|Z{1,2}|SSS/g
+
 export const now = new Date().getTime()
+
+export type DatetimeOptions = {
+  year: number
+  month?: number
+  day?: number
+  hour?: number
+  minute?: number
+  second?: number
+  millisecond?: number
+  locale?: string
+  utc?: boolean
+}
+
+function parseDate(date) {
+  if (date === null) return new Date(NaN)
+  if (!date) return new Date()
+  if (date instanceof Date) return new Date(date)
+  const utc = date.utc
+  if (typeof date === 'string' && !/Z$/i.test(date)) {
+    const d = date.match(REGEX_PARSE) as any
+    if (d) {
+      const m = d[2] - 1 || 0
+      const ms = (d[7] || '0').slice(0, 3)
+      if (utc) {
+        return new Date(Date.UTC(d[1], m, d[3] || 1, d[4] || 0, d[5] || 0, d[6] || 0, ms))
+      }
+      return new Date(d[1], m, d[3] || 1, d[4] || 0, d[5] || 0, d[6] || 0, ms)
+    }
+  }
+  return new Date(date)
+}
+
+export class Datetime {
+  #date = new Date() // defaults to now
+  #UTC = false // use current locale by default
+
+  constructor(opts?: string | number | Date | DatetimeOptions) {
+    this.#date = parseDate(opts)
+    this.#UTC = get('utc', opts, false)
+    // this.init()
+  }
+
+  // Display
+  // Format
+  format(locale?: string, opts?: Intl.DateTimeFormatOptions) {
+    if (opts && opts.timeZone === undefined && this.#UTC) {
+      opts.timeZone = 'utc'
+    }
+    return this.#date.toLocaleDateString(locale, opts)
+  }
+
+  // Time from now
+  // Time from X
+  // Difference
+
+  // Parsing
+  // Parse String + Date Format
+  // Parse String + Time Format
+  // Parse String + Format + locale
+
+  // Getter/Setters
+  // Hour/Minute/Second/Millis
+  // Day of Month
+  // Day of Week
+  // Day of Year
+  // Week of Year
+  // Days in Month
+  // Weeks in Year
+  // max of two dates
+  // min of two dates
+
+  // Manipulate
+  // Add
+  // Subtract
+  // Start of Time
+  // End of Time
+
+  // Query
+  // Is Before
+  // Is Same
+  // Is After
+  // Is Between
+  // Is Leap Year
+  // Is a Date
+}

package/core/index.d.ts

@@ -1,5 +1,4 @@
 export * from './collections/index.js';
-export * from './datetime/index.js';
 export * from './functools/index.js';
 export * from './globals/index.js';
 export * from './itertools/index.js';

package/core/index.js

@@ -1,5 +1,4 @@
 export * from './collections/index.js';
-export * from './datetime/index.js';
 export * from './functools/index.js';
 export * from './globals/index.js';
 export * from './itertools/index.js';

package/core/index.ts

@@ -1,5 +1,4 @@
 export * from './collections/index.js'
-export * from './datetime/index.js'
 export * from './functools/index.js'
 export * from './globals/index.js'
 export * from './itertools/index.js'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "atomic-fns",
   "description": "Like Lodash, but for ESNext and with types. Stop shipping code built for browsers from 2015.",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "main": "core/index.js",
   "type": "module",
   "types": "core/index.d.ts",