@dereekb/util 10.1.9 → 10.1.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/util",
-  "version": "10.1.9",
+  "version": "10.1.11",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/src/lib/date/hour.d.ts

@@ -36,3 +36,60 @@ export interface ComputeFractionalHour {
     readonly hours?: Maybe<Hours>;
 }
 export declare function computeNextFractionalHour(input: FractionalHour, change: ComputeFractionalHour): FractionalHour;
+/**
+ * The minute of the day.
+ *
+ * Number from 0-1439.
+ */
+export type MinuteOfDay = number;
+/**
+ * A pair of hours and minutes.
+ */
+export interface HoursAndMinutes {
+    readonly hour: number;
+    readonly minute: number;
+}
+/**
+ * Converts the input number of minutes to the equivalent in hours and minutes.
+ *
+ * @param inputMinutes
+ * @returns
+ */
+export declare function minutesToHoursAndMinutes(inputMinutes: Minutes): HoursAndMinutes;
+/**
+ * Reads the hour and minutes of the Date.
+ *
+ * @param date
+ * @returns
+ */
+export declare function dateToHoursAndMinutes(date: Date): HoursAndMinutes;
+/**
+ * Converts the input hours and minutes to a MinuteOfDay.
+ *
+ * @param hour
+ * @param minute
+ * @returns
+ */
+export declare function toMinuteOfDay(hour: Hours, minute: Minutes): MinuteOfDay;
+/**
+ * Creates a new date from the minute of the day.
+ *
+ * @param minuteOfDay
+ * @param day
+ * @returns
+ */
+export declare function dateFromMinuteOfDay(minuteOfDay: Minutes | MinuteOfDay, day?: Date): Date;
+/**
+ * Converts a Date to a MinuteOfDay.
+ *
+ * @param date
+ * @returns
+ */
+export declare function dateToMinuteOfDay(date: Date): MinuteOfDay;
+/**
+ * Converts the input minutes to a MinuteOfDay.
+ *
+ * @param minutes
+ * @returns
+ */
+export declare function asMinuteOfDay(minutes: Minutes): MinuteOfDay;

package/src/lib/iterable/iterable.d.ts

@@ -8,7 +8,33 @@ import { type Maybe } from '../value/maybe.type';
  */
 export type IterableOrValue<T> = T | Iterable<T>;
 export declare function asIterable<T = unknown>(values: IterableOrValue<T>, treatStringAsIterable?: boolean): Iterable<T>;
+/**
+ * Converts the input IterableOrValue value to an array.
+ *
+ * By default will treat strings as a non-iterable value, using the string as a single value.
+ *
+ * @param values
+ * @param treatStringAsIterable
+ * @returns
+ */
 export declare function iterableToArray<T = unknown>(values: IterableOrValue<T>, treatStringAsIterable?: boolean): T[];
+/**
+ * Converts the input IterableOrValue value to a Set.
+ *
+ * By default will treat strings as a non-iterable value, using the string as a single value.
+ *
+ * @param values
+ * @param treatStringAsIterable
+ * @returns
+ */
+export declare function iterableToSet<T = unknown>(values: IterableOrValue<T>, treatStringAsIterable?: boolean): Set<T>;
+/**
+ * Converts the input IterableOrValue value to a Map using the input readKey function.
+ *
+ * @param values
+ * @param readKey
+ * @returns
+ */
 export declare function iterableToMap<T, K extends PrimativeKey = PrimativeKey>(values: IterableOrValue<T>, readKey: ReadKeyFunction<T, K>): Map<Maybe<K>, T>;
 /**
  * Returns true if the input is an Iterable.

package/src/lib/model/id.factory.d.ts

@@ -0,0 +1,40 @@
+import { type Factory } from '../getter/getter';
+import { type NumberStringDencoderString, type NumberStringDencoder, type NumberStringDencoderNumber } from '../string/dencoder';
+import { type IndexNumber } from '../value/indexed';
+import { type Maybe } from '../value/maybe.type';
+/**
+ * A factory for generating a unique model identifier.
+ */
+export type ModelIdFactory = Factory<string>;
+export interface SequentialIncrementingNumberStringModelIdFactoryConfig {
+    /**
+     * Optional transform function to modify the resulting value.
+     */
+    readonly transform?: (encodedValue: NumberStringDencoderString, index: NumberStringDencoderNumber) => NumberStringDencoderString;
+    /**
+     * The dencoder to use.
+     *
+     * Default to NUMBER_STRING_DENCODER_64.
+     */
+    readonly dencoder?: Maybe<NumberStringDencoder>;
+    /**
+     * The current index. Will start at this index + increaseBy.
+     *
+     * Is ignored if startAt is provided.
+     */
+    readonly currentIndex?: Maybe<IndexNumber | NumberStringDencoderString>;
+    /**
+     * The index to start at.
+     */
+    readonly startAt?: Maybe<IndexNumber | NumberStringDencoderString>;
+    /**
+     * The value to increase by for each generated value.
+     *
+     * Defaults to 1.
+     */
+    readonly increaseBy?: number;
+}
+/**
+ * Creates a ModelIdFactory that generates sequential incrementing encoded NumberStringDencoderString values using the input configuration.
+ */
+export declare function sequentialIncrementingNumberStringModelIdFactory(config?: SequentialIncrementingNumberStringModelIdFactoryConfig): ModelIdFactory;

package/src/lib/model/index.d.ts

@@ -1,6 +1,7 @@
+export * from './id.batch';
+export * from './id.factory';
 export * from './model';
 export * from './model.copy';
 export * from './model.conversion';
 export * from './model.conversion.field';
 export * from './model.modify';
-export * from './id.batch';

package/src/lib/string/char.d.ts

@@ -79,3 +79,12 @@ export declare const UTF_8_START_CHARACTER = "\0";
  * https://firebase.google.com/docs/database/rest/retrieve-data#range-queries
  */
 export declare const UTF_PRIVATE_USAGE_AREA_START = "\uF8FF";
+/**
+ * Takes in a string and returns a Record that has the index value mapped to the property of the character.
+ *
+ * The latest character index is used in collision cases.
+ *
+ * @param chars
+ * @returns
+ */
+export declare function stringCharactersToIndexRecord(chars: string): Record<string, number>;

package/src/lib/string/dencoder.d.ts

@@ -1,5 +1,6 @@
 import { type PrimativeKey } from '../key';
 import { type FactoryWithRequiredInput } from '../getter/getter';
+import { type Maybe } from '../value/maybe.type';
 /**
  * Map object of PrimativeKey dencoder values, keyed by the encoded value.
  */
@@ -66,3 +67,81 @@ export type PrimativeKeyStringDencoderFunction<D extends PrimativeKey, E extends
  * @returns
  */
 export declare function primativeKeyStringDencoder<D extends PrimativeKey, E extends PrimativeKey>(config: PrimativeKeyStringDencoderConfig<D, E>): PrimativeKeyStringDencoderFunction<D, E>;
+/**
+ * An encodable number. This is typically a positive integer value.
+ */
+export type NumberStringDencoderNumber = number;
+/**
+ * A number-encoded string. Little-Endian. Should Decode to the same value each time.
+ */
+export type NumberStringDencoderString = string;
+/**
+ * Digits used when encoding/decoding a value.
+ *
+ * The number of digits/characters must be a factor of 2. I.E. 8, 16, 32, 64
+ */
+export type NumberStringDencoderDigits = string;
+/**
+ * The number of "bits" given by the NumberStringDencoderDigits.
+ */
+export type NumberStringDencoderBitDepth = 2 | 4 | 8 | 16 | 32 | 64;
+/**
+ * Default 64 NumberStringDencoderDigits value.
+ */
+export declare const NUMBER_STRING_DENCODER_64_DIGITS: NumberStringDencoderDigits;
+/**
+ * The default negative prefix for negative numbers.
+ */
+export declare const NUMBER_STRING_DENCODER_64_DEFAULT_NEGATIVE_PREFIX = "!";
+/**
+ * The NumberString dencoder type
+ * - positive_integer: can only encode/decode positive integers
+ * - integer: can only encode/decode integers
+ * - positive_decimal: can encoded/decode positive decimals
+ * - decimal: can encoded/decode decimals
+ */
+export type NumberStringDencoderType = 'positive_integer' | 'integer' | 'positive_decimal' | 'decimal';
+/**
+ * A NumberString dencoder.
+ *
+ * Can encode/decode a number from the input string.
+ */
+export interface NumberStringDencoder {
+    readonly type: NumberStringDencoderType;
+    readonly digits: NumberStringDencoderDigits;
+    readonly bitDepth: NumberStringDencoderBitDepth;
+    readonly negativePrefix?: Maybe<string>;
+    /**
+     * Encodes the input number to the corresponding NumberStringDencoderString.
+     *
+     * @param number
+     */
+    encodeNumber(number: NumberStringDencoderNumber): NumberStringDencoderString;
+    /**
+     * Decodes the input number to the corresponding NumberStringDencoderNumber.
+     *
+     * @param encodedNumber
+     */
+    decodeNumber(encodedNumber: NumberStringDencoderString): NumberStringDencoderNumber;
+}
+export interface NumberStringDencoderConfig {
+    /**
+     * Optional negative prefix character. Should not be in the digits.
+     */
+    readonly negativePrefix?: Maybe<string>;
+    readonly digits: NumberStringDencoderDigits;
+}
+/**
+ * Creates an integer-type NumberStringDencoder.
+ *
+ * If the config does not include a negative prefix, any negative number will be treated like a positive number.
+ *
+ * @param config
+ * @returns
+ */
+export declare function numberStringDencoder(config: NumberStringDencoderConfig): NumberStringDencoder;
+export declare const NUMBER_STRING_DENCODER_64: NumberStringDencoder;
+export type NumberStringDencoderFunction = ((input: NumberStringDencoderString) => NumberStringDencoderNumber) & ((input: NumberStringDencoderNumber) => NumberStringDencoderString);
+export declare function numberStringDencoderFunction(dencoder: NumberStringDencoder): NumberStringDencoderFunction;
+export declare function numberStringDencoderEncodedStringValueFunction(dencoder: NumberStringDencoder): (input: NumberStringDencoderString | NumberStringDencoderNumber) => NumberStringDencoderString;
+export declare function numberStringDencoderDecodedNumberValueFunction(dencoder: NumberStringDencoder): (input: NumberStringDencoderString | NumberStringDencoderNumber) => NumberStringDencoderNumber;

package/src/lib/string/transform.d.ts

@@ -46,7 +46,7 @@ export declare function addSuffix(suffix: string, input: string): string;
 /**
  * Function that adds a configured suffix to the input string if it does not exist on that string.
  */
-export type AddSuffixFunction = (input: string) => string;
+export type AddSuffixFunction = TransformStringFunction;
 /**
  * Creates an AddSuffixFunction
  *
@@ -56,3 +56,14 @@ export type AddSuffixFunction = (input: string) => string;
  * @returns
  */
 export declare function addSuffixFunction(suffix: string): AddSuffixFunction;
+/**
+ * Function that pads the start of a string to a minimum length.
+ */
+export type PadStartFunction = TransformStringFunction;
+/**
+ *
+ * @param minLength
+ * @param padCharacter
+ * @returns
+ */
+export declare function padStartFunction(minLength: number, padCharacter: string): PadStartFunction;

package/test/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [10.1.11](https://github.com/dereekb/dbx-components/compare/v10.1.10-dev...v10.1.11) (2024-04-27)
+
+
+
+## [10.1.10](https://github.com/dereekb/dbx-components/compare/v10.1.9-dev...v10.1.10) (2024-04-12)
+
+
+
 ## [10.1.9](https://github.com/dereekb/dbx-components/compare/v10.1.8-dev...v10.1.9) (2024-04-10)
 
 

package/test/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/util/test",
-  "version": "10.1.9",
+  "version": "10.1.11",
   "type": "commonjs",
   "peerDependencies": {
     "@dereekb/util": "*"