@stryke/helpers 0.10.12 → 0.10.14

package/dist/types/src/object.d.mts

@@ -1,125 +0,0 @@
-import { Index40, Nullish } from "./base.mjs";
-import { StringKeyOf } from "./json.mjs";
-import { StringDigit } from "./string.mjs";
-
-//#region ../types/src/object.d.ts
-
-interface GetOptions {
-  /**
-   * Include `undefined` in the return type when accessing properties.
-   *
-   * Setting this to `false` is not recommended.
-   *
-   * @defaultValue `true`
-   */
-  strict?: boolean;
-}
-/**
- * Like the `Get` type but receives an array of strings as a path parameter.
- */
-type GetWithPath<BaseType, Keys extends readonly string[], Options extends GetOptions = {}> = Keys extends readonly [] ? BaseType : Keys extends readonly [infer Head, ...infer Tail] ? GetWithPath<PropertyOf<BaseType, Extract<Head, string>, Options>, Extract<Tail, string[]>, Options> : never;
-/**
- * Adds `undefined` to `Type` if `strict` is enabled.
- */
-type Strictify<Type, Options extends GetOptions> = Options["strict"] extends false ? Type : Type | undefined;
-/**
- *  If `Options['strict']` is `true`, includes `undefined` in the returned type when accessing properties on `Record<string, any>`.
- *
- *  Known limitations:
- *  - Does not include `undefined` in the type on object types with an index signature (for example, `{a: string; [key: string]: string}`).
- */
-type StrictPropertyOf<BaseType, Key$1 extends keyof BaseType, Options extends GetOptions> = Record<string, any> extends BaseType ? string extends keyof BaseType ? Strictify<BaseType[Key$1], Options> : BaseType[Key$1] : BaseType[Key$1];
-/**
- * Represents an array of strings split using a given character or character set.
- *
- * Use-case: Defining the return type of a method like `String.prototype.split`.
- *
- * @example
- * ```
- * import type {Split} from 'type-fest';
- *
- * declare function split<S extends string, D extends string>(string: S, separator: D): Split<S, D>;
- *
- * type Item = 'foo' | 'bar' | 'baz' | 'waldo';
- * const items = 'foo,bar,baz,waldo';
- * let array: Item[];
- *
- * array = split(items, ',');
- * ```
- */
-type Split<S extends string, Delimiter extends string> = S extends `${infer Head}${Delimiter}${infer Tail}` ? [Head, ...Split<Tail, Delimiter>] : S extends Delimiter ? [] : [S];
-/**
- * Splits a dot-prop style path into a tuple comprised of the properties in the path. Handles square-bracket notation.
- *
- * @example
- * ```
- * ToPath<'foo.bar.baz'>
- * //=> ['foo', 'bar', 'baz']
- *
- * ToPath<'foo[0].bar.baz'>
- * //=> ['foo', '0', 'bar', 'baz']
- * ```
- */
-type ToPath<S extends string> = Split<FixPathSquareBrackets<S>, ".">;
-/**
- * Replaces square-bracketed dot notation with dots, for example, `foo[0].bar` -\> `foo.0.bar`.
- */
-type FixPathSquareBrackets<Path extends string> = Path extends `[${infer Head}]${infer Tail}` ? Tail extends `[${string}` ? `${Head}.${FixPathSquareBrackets<Tail>}` : `${Head}${FixPathSquareBrackets<Tail>}` : Path extends `${infer Head}[${infer Middle}]${infer Tail}` ? `${Head}.${FixPathSquareBrackets<`[${Middle}]${Tail}`>}` : Path;
-/**
- * Returns true if `LongString` is made up out of `Substring` repeated 0 or more times.
- *
- * @example
- * ```ts
- * ConsistsOnlyOf<'aaa', 'a'> //=> true
- * ConsistsOnlyOf<'ababab', 'ab'> //=> true
- * ConsistsOnlyOf<'aBa', 'a'> //=> false
- * ConsistsOnlyOf<'', 'a'> //=> true
- * ```
- *
- */
-type ConsistsOnlyOf<LongString extends string, Substring extends string> = LongString extends "" ? true : LongString extends `${Substring}${infer Tail}` ? ConsistsOnlyOf<Tail, Substring> : false;
-/**
- * Convert a type which may have number keys to one with string keys, making it possible to index using strings retrieved from template types.
- *
- * @example
- *
- * ```ts
- * type WithNumbers = {foo: string; 0: boolean};
- * type WithStrings = WithStringKeys<WithNumbers>;
- *
- * type WithNumbersKeys = keyof WithNumbers;
- * //=> 'foo' | 0
- * type WithStringsKeys = keyof WithStrings;
- * //=> 'foo' | '0'
- * ```
- *
- */
-type WithStringKeys<BaseType> = { [Key in StringKeyOf<BaseType>]: UncheckedIndex<BaseType, Key> };
-/**
-    Perform a `T[U]` operation if `T` supports indexing.
- */
-type UncheckedIndex<T, U$1 extends number | string> = [T] extends [Record<number | string, any>] ? T[U$1] : never;
-/**
- *  Get a property of an object or array. Works when indexing arrays using number-literal-strings, for example, `PropertyOf<number[], '0'> = number`, and when indexing objects with number keys.
- *
- * Note:
- * - Returns `unknown` if `Key` is not a property of `BaseType`, since TypeScript uses structural typing, and it cannot be guaranteed that extra properties unknown to the type system will exist at runtime.
- * - Returns `undefined` from nullish values, to match the behavior of most deep-key libraries like `lodash`, `dot-prop`, etc.
- */
-type PropertyOf<BaseType, Key$1 extends string, Options extends GetOptions = {}> = BaseType extends Nullish ? undefined : Key$1 extends keyof BaseType ? StrictPropertyOf<BaseType, Key$1, Options> : BaseType extends readonly [] | readonly [unknown, ...unknown[]] ? unknown : BaseType extends {
-  [n: number]: infer Item;
-  length: number;
-} ? ConsistsOnlyOf<Key$1, StringDigit> extends true ? Strictify<Item, Options> : unknown : Key$1 extends keyof WithStringKeys<BaseType> ? StrictPropertyOf<WithStringKeys<BaseType>, Key$1, Options> : unknown;
-type IsTuple<T> = T extends {
-  length: infer Length;
-} & readonly any[] ? Length extends Index40 ? T : never : never;
-type AllowedIndexes<Tuple extends readonly any[], Keys extends number = never> = Tuple extends readonly [] ? Keys : Tuple extends readonly [infer _First, ...infer Tail] ? AllowedIndexes<Tail, Keys | Tail["length"]> : Keys;
-type PrefixArrayAccessor<T extends any[], TDepth extends any[]> = { [K in keyof T]: `[${number}]${DeepKey<T[K], TDepth>}` }[number];
-type PrefixTupleAccessor<T extends any[], TIndex extends number, TDepth extends any[]> = { [K in TIndex]: `[${K}]${DeepKey<T[K], TDepth>}` | `[${K}]` }[TIndex];
-type PrefixObjectAccessor<T extends object, TDepth extends any[]> = { [K in keyof T]-?: K extends number | string ? `${PrefixFromDepth<K, TDepth>}${DeepKey<T[K], [TDepth]>}` | PrefixFromDepth<K, TDepth> : never }[keyof T];
-type PrefixFromDepth<T extends number | string, TDepth extends any[]> = TDepth["length"] extends 0 ? T : `.${T}`;
-type DeepKey<T, TDepth extends any[] = []> = TDepth["length"] extends 5 ? never : unknown extends T ? PrefixFromDepth<string, TDepth> : T extends IsTuple<T> & any[] ? PrefixTupleAccessor<T, AllowedIndexes<T>, TDepth> : T extends any[] ? PrefixArrayAccessor<T, [...TDepth, any]> : T extends Date ? never : T extends object ? PrefixObjectAccessor<T, TDepth> : T extends bigint | boolean | number | string ? "" : never;
-type DeepValue<TObject extends Record<string, unknown>, TPath extends DeepKey<TObject>> = GetWithPath<TObject, ToPath<TPath>>;
-//#endregion
-export { DeepKey, DeepValue };
-//# sourceMappingURL=object.d.mts.map

package/dist/types/src/object.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"object.d.mts","names":[],"sources":["../../../../types/src/object.ts"],"sourcesContent":[],"mappings":";;;;;;UA8OU,UAAA,CAsLA;EAAiC;;;;;;;EACf,MAAA,CAAA,EAAA,OAAA;AA6Q2C;;;;AAOhE,KA7bK,WA6bL,CAAA,QAAA,EAAA,aAAA,SAAA,MAAA,EAAA,EAAA,gBAzbW,UAybX,GAAA,CAAA,CAAA,CAAA,GAxbH,IAwbG,SAAA,SAAA,EAAA,GAvbH,QAubG,GAtbH,IAsbG,SAAA,SAAA,CAAA,KAAA,KAAA,EAAA,GAAA,KAAA,KAAA,CAAA,GArbD,WAqbC,CApbC,UAobD,CApbY,QAobZ,EApbsB,OAobtB,CApb8B,IAob9B,EAAA,MAAA,CAAA,EApb6C,OAob7C,CAAA,EAnbC,OAmbD,CAnbS,IAmbT,EAAA,MAAA,EAAA,CAAA,EAlbC,OAkbD,CAAA,GAAA,KAAA;AAAA;;;KA3aF,SAqbD,CAAA,IAAA,EAAA,gBAnbc,UAmbd,CAAA,GAlbA,OAkbA,CAAA,QAAA,CAAA,SAAA,KAAA,GAlbkC,IAkblC,GAlbyC,IAkbzC,GAAA,SAAA;;;;;;;AAEM,KA5aL,gBA8aA,CAAA,QAAmB,EAAA,cAAA,MA5aJ,QA4aI,EAAA,gBA3aN,UA2aM,CAAA,GAzatB,MAyasB,CAAA,MAAA,EAAA,GAAA,CAAA,SAzaM,QAyaN,GAAA,MAAA,SAAA,MAxaG,QAwaH,GAvahB,SAuagB,CAvaN,QAuaM,CAvaG,KAuaH,CAAA,EAvaS,OAuaT,CAAA,GAtahB,QAsagB,CAtaP,KAsaO,CAAA,GAralB,QAqakB,CAraT,KAqaS,CAAA;;;;;;;AACe;;;;;;;;;;AAS/B;;AAGY,KA9ZR,KA8ZQ,CAAA,UAAA,MAAA,EAAA,kBAAA,MAAA,CAAA,GA3ZhB,CA2ZgB,SAAA,GAAA,KAAA,KAAA,GA3ZU,SA2ZV,GAAA,KAAA,KAAA,EAAA,GAAA,CA1Zf,IA0Ze,EAAA,GA1ZN,KA0ZM,CA1ZA,IA0ZA,EA1ZM,SA0ZN,CAAA,CAAA,GAzZhB,CAyZgB,SAzZN,SAyZM,GAAA,EAAA,GAAA,CAvZb,CAuZa,CAAA;;;;;;;;;;;;;AAOf,KAhZO,MAgZP,CAAA,UAAe,MAAA,CAAA,GAhZmB,KAgZnB,CAhZyB,qBAgZzB,CAhZ+C,CAgZ/C,CAAA,EAAA,GAAA,CAAA;;;;KA3Yf,qBA8YqC,CAAA,aAAA,MAAA,CAAA,GA7YxC,IA6YwC,SAAA,IAAA,KAAA,KAAA,IAAA,KAAA,KAAA,EAAA,GAAA,IAAA,SAAA,IAAA,MAAA,EAAA,GAAA,GA3Y/B,IA2Y+B,IA3YvB,qBA2YuB,CA3YD,IA2YC,CAAA,EAAA,GAAA,GA1Y/B,IA0Y+B,GA1YxB,qBA0YwB,CA1YF,IA0YE,CAAA,EAAA,GAzYpC,IAyYoC,SAAA,GAAA,KAAA,KAAA,IAAA,KAAA,OAAA,IAAA,KAAA,KAAA,EAAA,GAAA,GAxY/B,IAwY+B,IAxYvB,qBAwYuB,CAAA,IAxYG,MAwYH,IAxYa,IAwYb,EAAA,CAAA,EAAA,GAvYlC,IAuYkC;AAE1C;;;;;;;;;;;;KA3XK,cAgYG,CAAA,mBAAA,MAAA,EAAA,kBAAA,MAAA,CAAA,GA7XJ,UA6XI,SAAA,EAAA,GAAA,IAAA,GA3XJ,UA2XI,SAAA,GA3XkB,SA2XlB,GAAA,KAAA,KAAA,EAAA,GA1XF,cA0XE,CA1Xa,IA0Xb,EA1XmB,SA0XnB,CAAA,GAAA,KAAA;;;;;;;;;;;;;AAoBR;;;;KA3XK,cA8XW,CAAA,QAAA,CAAA,GAAA,UA7XN,WA6XsB,CA7XV,QA6XU,CAAA,GA7XE,cA6XF,CA7XiB,QA6XjB,EA7X2B,GA6X3B,CAAA,EAAP;;;;KAvXpB,kDAAgD,YACnD,gCAEE,EAAE;;;;;;;;KAUM,2DAIM,mBACd,iBAAiB,sBAEjB,oBAAkB,WAChB,iBAAiB,UAAU,OAAK,WAChC,4EAEE;;;IAIE,eAAe,OAAK,4BAClB,UAAU,MAAM,qBAElB,oBAAkB,eAAe,YAC/B,iBAAiB,eAAe,WAAW,OAAK;KAkRvD,aAAa;;oCACC,UACb;KAKD,4EAGD,4BACA,OACA,uDACE,eAAe,MAAM,OAAO,kBAC5B;KAED,2EACS,kBAAkB,QAAQ,EAAE,IAAI;KAGzC,4FAKG,aAAa,KAAK,QAAQ,EAAE,IAAI,gBAAgB,OACtD;KAEG,6EACS,MAAM,+BAEP,gBAAgB,GAAG,UAAU,QAAQ,EAAE,KAAK,aAC/C,gBAAgB,GAAG,wBAErB;KAEH,mEAGD,6BAA6B,QAAQ;KAE7B,wCAAwC,qDAEhC,IACd,wBAAwB,UACxB,UAAU,QAAQ,aAChB,oBAAoB,GAAG,eAAe,IAAI,UAC1C,kBACE,oBAAoB,OAAO,gBAC3B,UAAU,eAER,mBACE,qBAAqB,GAAG,UACxB;KAaF,0BACM,uCACF,QAAQ,YACpB,YAAY,SAAS,OAAO"}

package/dist/types/src/string.d.cts

@@ -1,6 +0,0 @@
-//#region ../types/src/string.d.ts
-
-type StringDigit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
-//#endregion
-export { StringDigit };
-//# sourceMappingURL=string.d.cts.map

package/dist/types/src/string.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"string.d.cts","names":[],"sources":["../../../../types/src/string.ts"],"sourcesContent":[],"mappings":";;KAiJY,WAAA"}

package/dist/types/src/string.d.mts

@@ -1,6 +0,0 @@
-//#region ../types/src/string.d.ts
-
-type StringDigit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
-//#endregion
-export { StringDigit };
-//# sourceMappingURL=string.d.mts.map

package/dist/types/src/string.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"string.d.mts","names":[],"sources":["../../../../types/src/string.ts"],"sourcesContent":[],"mappings":";;KAiJY,WAAA"}