@zayne-labs/toolkit-type-helpers 0.12.13 → 0.12.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/index.d.ts +13 -11
- package/dist/esm/index.js.map +1 -1
- package/package.json +1 -1
package/dist/esm/index.d.ts
CHANGED
|
@@ -8,6 +8,7 @@ type PrettyOmit<TObject, Key$1 extends keyof TObject> = Prettify<Omit<TObject, K
|
|
|
8
8
|
type PrettyPick<TObject, Key$1 extends keyof TObject> = Prettify<Pick<TObject, Key$1>>;
|
|
9
9
|
type CallbackFn<in TParams, out TResult = void> = (...params: TParams[]) => TResult;
|
|
10
10
|
type SelectorFn<TStore, TResult> = (state: TStore) => TResult;
|
|
11
|
+
type DistributiveOmit<TObject, TKeysToOmit extends keyof TObject> = TObject extends unknown ? Omit<TObject, TKeysToOmit> : never;
|
|
11
12
|
type NonEmptyArray<TArrayItem> = [TArrayItem, ...TArrayItem[]];
|
|
12
13
|
type UnknownObject = UnmaskType<Record<string, unknown>>;
|
|
13
14
|
type EmptyObject = NonNullable<unknown>;
|
|
@@ -118,24 +119,25 @@ type DefineEnumOptions = {
|
|
|
118
119
|
unionVariant?: UnionVariant;
|
|
119
120
|
writeableLevel?: WriteableLevel;
|
|
120
121
|
};
|
|
121
|
-
type EnumWithInferredUnionType<TResult, TUnionVariant extends UnionVariant> = TResult & {
|
|
122
|
-
$inferUnion: ExtractUnion<TResult, TUnionVariant>;
|
|
123
|
-
};
|
|
124
122
|
type DefaultDefineEnumOptions = {
|
|
125
123
|
unionVariant: "keys";
|
|
126
124
|
writeableLevel: "shallow";
|
|
127
125
|
};
|
|
128
|
-
declare const defineEnum: <const TValue extends object, TOptions extends DefineEnumOptions =
|
|
126
|
+
declare const defineEnum: <const TValue extends object, TOptions extends DefineEnumOptions = DefineEnumOptions, TComputedWriteableLevel extends WriteableLevel = ([TOptions["writeableLevel"]] extends [WriteableLevel] ? TOptions["writeableLevel"] : DefaultDefineEnumOptions["writeableLevel"]), TComputedUnionVariant extends UnionVariant = ([TOptions["unionVariant"]] extends [UnionVariant] ? TOptions["unionVariant"] : DefaultDefineEnumOptions["unionVariant"])>(value: TValue, _options?: TOptions) => Writeable<TValue, TComputedWriteableLevel> & {
|
|
127
|
+
$inferUnion: ExtractUnion<TValue, TComputedUnionVariant>;
|
|
128
|
+
};
|
|
129
129
|
type DefineEnumDeepOptions = Pick<DefineEnumOptions, "unionVariant">;
|
|
130
|
-
declare const defineEnumDeep: <const TValue extends object, TOptions extends DefineEnumDeepOptions = DefineEnumDeepOptions>(value: TValue, _options?: TOptions) =>
|
|
130
|
+
declare const defineEnumDeep: <const TValue extends object, TOptions extends DefineEnumDeepOptions = DefineEnumDeepOptions>(value: TValue, _options?: TOptions) => Writeable<TValue, [(TOptions & {
|
|
131
131
|
writeableLevel: "deep";
|
|
132
132
|
})["writeableLevel"]] extends [WriteableLevel] ? (TOptions & {
|
|
133
133
|
writeableLevel: "deep";
|
|
134
|
-
})["writeableLevel"] : "shallow"
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
134
|
+
})["writeableLevel"] : "shallow"> & {
|
|
135
|
+
$inferUnion: ExtractUnion<TValue, [(TOptions & {
|
|
136
|
+
writeableLevel: "deep";
|
|
137
|
+
})["unionVariant"]] extends [UnionVariant] ? (TOptions & {
|
|
138
|
+
writeableLevel: "deep";
|
|
139
|
+
})["unionVariant"] : "keys">;
|
|
140
|
+
};
|
|
139
141
|
//#endregion
|
|
140
|
-
export { AnyAsyncFunction, AnyFunction, AnyNumber, AnyObject, AnyString, AssertionError, Awaitable, CallbackFn, EmptyObject, Equal, Expect, ExtractUnion, LiteralUnion, NonEmptyArray, NonFalsy, Prettify, PrettyOmit, PrettyPick, SelectorFn, UnionDiscriminator, UnionToIntersection, UnionVariant, UnknownObject, UnknownObjectWithAnyKey, UnmaskType, Writeable, WriteableLevel, assert, assertDefined, assertENV, defineEnum, defineEnumDeep, hasObjectPrototype, isArray, isAsyncFunction, isBlob, isBoolean, isFile, isFormData, isFunction, isIterable, isJsonString, isNumber, isObject, isObjectAndNotArray, isPlainObject, isString, isSymbol };
|
|
142
|
+
export { AnyAsyncFunction, AnyFunction, AnyNumber, AnyObject, AnyString, AssertionError, Awaitable, CallbackFn, DistributiveOmit, EmptyObject, Equal, Expect, ExtractUnion, LiteralUnion, NonEmptyArray, NonFalsy, Prettify, PrettyOmit, PrettyPick, SelectorFn, UnionDiscriminator, UnionToIntersection, UnionVariant, UnknownObject, UnknownObjectWithAnyKey, UnmaskType, Writeable, WriteableLevel, assert, assertDefined, assertENV, defineEnum, defineEnumDeep, hasObjectPrototype, isArray, isAsyncFunction, isBlob, isBoolean, isFile, isFormData, isFunction, isIterable, isJsonString, isNumber, isObject, isObjectAndNotArray, isPlainObject, isString, isSymbol };
|
|
141
143
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["assert: AssertFn"],"sources":["../../src/guard.ts","../../src/assert.ts","../../src/enum.ts"],"sourcesContent":["import type {\n\tAnyAsyncFunction,\n\tAnyFunction,\n\tUnknownObject,\n\tUnknownObjectWithAnyKey,\n} from \"./type-utils/common\";\n\nexport const isString = (value: unknown) => typeof value === \"string\";\n\nexport const isNumber = (value: unknown) => typeof value === \"number\";\n\nexport const isSymbol = (value: unknown) => typeof value === \"symbol\";\n\nexport const isBoolean = (value: unknown) => typeof value === \"boolean\";\n\nexport const isArray = <TArray>(value: unknown): value is TArray[] => Array.isArray(value);\n\nexport const isFormData = (value: unknown) => value instanceof FormData;\n\nexport const isObject = <TObject extends object>(value: unknown): value is TObject =>\n\ttypeof value === \"object\" && value !== null;\n\nexport const isObjectAndNotArray = <TObject = UnknownObject>(value: unknown): value is TObject => {\n\treturn isObject(value) && !isArray(value);\n};\n\nexport const hasObjectPrototype = (value: unknown) => {\n\treturn Object.prototype.toString.call(value) === \"[object Object]\";\n};\n\n/**\n * @description Copied from TanStack Query's isPlainObject\n * @see https://github.com/TanStack/query/blob/main/packages/query-core/src/utils.ts#L321\n */\nexport const isPlainObject = <TPlainObject extends UnknownObjectWithAnyKey = UnknownObject>(\n\tvalue: unknown\n): value is TPlainObject => {\n\tif (!hasObjectPrototype(value)) {\n\t\treturn false;\n\t}\n\n\t// If has no constructor\n\tconst constructor = (value as object | undefined)?.constructor;\n\tif (constructor === undefined) {\n\t\treturn true;\n\t}\n\n\t// If has modified prototype\n\tconst prototype = constructor.prototype as object;\n\tif (!hasObjectPrototype(prototype)) {\n\t\treturn false;\n\t}\n\n\t// If constructor does not have an Object-specific method\n\tif (!Object.hasOwn(prototype, \"isPrototypeOf\")) {\n\t\treturn false;\n\t}\n\n\t// Handles Objects created by Object.create(<arbitrary prototype>)\n\tif (Object.getPrototypeOf(value) !== Object.prototype) {\n\t\treturn false;\n\t}\n\n\t// It's probably a plain object at this point\n\treturn true;\n};\n\nexport const isFunction = <TFunction extends AnyFunction>(value: unknown): value is TFunction => {\n\treturn typeof value === \"function\";\n};\n\nexport const isAsyncFunction = <TAsyncFunction extends AnyAsyncFunction>(\n\tvalue: unknown\n): value is TAsyncFunction => {\n\treturn isFunction(value) && value.constructor.name === \"AsyncFunction\";\n};\n\nexport const isFile = (value: unknown) => value instanceof File;\n\nexport const isBlob = (value: unknown) => value instanceof Blob;\n\nexport const isIterable = <TIterable>(obj: object): obj is Iterable<TIterable> => Symbol.iterator in obj;\n\nexport const isJsonString = (value: unknown): value is string => {\n\tif (!isString(value)) {\n\t\treturn false;\n\t}\n\n\ttry {\n\t\tJSON.parse(value);\n\t\treturn true;\n\t} catch {\n\t\treturn false;\n\t}\n};\n","import { isString } from \"./guard\";\n\nexport class AssertionError extends Error {\n\toverride name = \"AssertionError\";\n\n\tconstructor(message?: string) {\n\t\tconst prefix = \"Assertion failed\";\n\n\t\tsuper(message ? `${prefix}: ${message}` : message);\n\t}\n}\n\nexport const assertDefined = <TValue>(value: TValue) => {\n\tif (value == null) {\n\t\tthrow new AssertionError(`The value passed is \"${value as null | undefined}!\"`);\n\t}\n\n\treturn value;\n};\n\nexport const assertENV = (variable: string | undefined, message?: string) => {\n\tif (variable === undefined) {\n\t\tthrow new AssertionError(message);\n\t}\n\n\treturn variable;\n};\n\ntype AssertOptions = {\n\tmessage: string;\n};\n\ntype AssertFn = {\n\t(condition: boolean, messageOrOptions?: string | AssertOptions): asserts condition;\n\n\t<TValue>(\n\t\tvalue: TValue,\n\t\tmessageOrOptions?: string | AssertOptions\n\t): asserts value is NonNullable<TValue>;\n};\n\nexport const assert: AssertFn = (input: unknown, messageOrOptions?: string | AssertOptions) => {\n\tif (input === false || input == null) {\n\t\tconst message = isString(messageOrOptions) ? messageOrOptions : messageOrOptions?.message;\n\n\t\tthrow new AssertionError(message);\n\t}\n};\n","import type { ExtractUnion, UnionVariant, Writeable, WriteableLevel } from \"./type-utils\";\n\ntype DefineEnumOptions = {\n\tunionVariant?: UnionVariant;\n\twriteableLevel?: WriteableLevel;\n};\n\ntype
|
|
1
|
+
{"version":3,"file":"index.js","names":["assert: AssertFn"],"sources":["../../src/guard.ts","../../src/assert.ts","../../src/enum.ts"],"sourcesContent":["import type {\n\tAnyAsyncFunction,\n\tAnyFunction,\n\tUnknownObject,\n\tUnknownObjectWithAnyKey,\n} from \"./type-utils/common\";\n\nexport const isString = (value: unknown) => typeof value === \"string\";\n\nexport const isNumber = (value: unknown) => typeof value === \"number\";\n\nexport const isSymbol = (value: unknown) => typeof value === \"symbol\";\n\nexport const isBoolean = (value: unknown) => typeof value === \"boolean\";\n\nexport const isArray = <TArray>(value: unknown): value is TArray[] => Array.isArray(value);\n\nexport const isFormData = (value: unknown) => value instanceof FormData;\n\nexport const isObject = <TObject extends object>(value: unknown): value is TObject =>\n\ttypeof value === \"object\" && value !== null;\n\nexport const isObjectAndNotArray = <TObject = UnknownObject>(value: unknown): value is TObject => {\n\treturn isObject(value) && !isArray(value);\n};\n\nexport const hasObjectPrototype = (value: unknown) => {\n\treturn Object.prototype.toString.call(value) === \"[object Object]\";\n};\n\n/**\n * @description Copied from TanStack Query's isPlainObject\n * @see https://github.com/TanStack/query/blob/main/packages/query-core/src/utils.ts#L321\n */\nexport const isPlainObject = <TPlainObject extends UnknownObjectWithAnyKey = UnknownObject>(\n\tvalue: unknown\n): value is TPlainObject => {\n\tif (!hasObjectPrototype(value)) {\n\t\treturn false;\n\t}\n\n\t// If has no constructor\n\tconst constructor = (value as object | undefined)?.constructor;\n\tif (constructor === undefined) {\n\t\treturn true;\n\t}\n\n\t// If has modified prototype\n\tconst prototype = constructor.prototype as object;\n\tif (!hasObjectPrototype(prototype)) {\n\t\treturn false;\n\t}\n\n\t// If constructor does not have an Object-specific method\n\tif (!Object.hasOwn(prototype, \"isPrototypeOf\")) {\n\t\treturn false;\n\t}\n\n\t// Handles Objects created by Object.create(<arbitrary prototype>)\n\tif (Object.getPrototypeOf(value) !== Object.prototype) {\n\t\treturn false;\n\t}\n\n\t// It's probably a plain object at this point\n\treturn true;\n};\n\nexport const isFunction = <TFunction extends AnyFunction>(value: unknown): value is TFunction => {\n\treturn typeof value === \"function\";\n};\n\nexport const isAsyncFunction = <TAsyncFunction extends AnyAsyncFunction>(\n\tvalue: unknown\n): value is TAsyncFunction => {\n\treturn isFunction(value) && value.constructor.name === \"AsyncFunction\";\n};\n\nexport const isFile = (value: unknown) => value instanceof File;\n\nexport const isBlob = (value: unknown) => value instanceof Blob;\n\nexport const isIterable = <TIterable>(obj: object): obj is Iterable<TIterable> => Symbol.iterator in obj;\n\nexport const isJsonString = (value: unknown): value is string => {\n\tif (!isString(value)) {\n\t\treturn false;\n\t}\n\n\ttry {\n\t\tJSON.parse(value);\n\t\treturn true;\n\t} catch {\n\t\treturn false;\n\t}\n};\n","import { isString } from \"./guard\";\n\nexport class AssertionError extends Error {\n\toverride name = \"AssertionError\";\n\n\tconstructor(message?: string) {\n\t\tconst prefix = \"Assertion failed\";\n\n\t\tsuper(message ? `${prefix}: ${message}` : message);\n\t}\n}\n\nexport const assertDefined = <TValue>(value: TValue) => {\n\tif (value == null) {\n\t\tthrow new AssertionError(`The value passed is \"${value as null | undefined}!\"`);\n\t}\n\n\treturn value;\n};\n\nexport const assertENV = (variable: string | undefined, message?: string) => {\n\tif (variable === undefined) {\n\t\tthrow new AssertionError(message);\n\t}\n\n\treturn variable;\n};\n\ntype AssertOptions = {\n\tmessage: string;\n};\n\ntype AssertFn = {\n\t(condition: boolean, messageOrOptions?: string | AssertOptions): asserts condition;\n\n\t<TValue>(\n\t\tvalue: TValue,\n\t\tmessageOrOptions?: string | AssertOptions\n\t): asserts value is NonNullable<TValue>;\n};\n\nexport const assert: AssertFn = (input: unknown, messageOrOptions?: string | AssertOptions) => {\n\tif (input === false || input == null) {\n\t\tconst message = isString(messageOrOptions) ? messageOrOptions : messageOrOptions?.message;\n\n\t\tthrow new AssertionError(message);\n\t}\n};\n","import type { ExtractUnion, UnionVariant, Writeable, WriteableLevel } from \"./type-utils\";\n\ntype DefineEnumOptions = {\n\tunionVariant?: UnionVariant;\n\twriteableLevel?: WriteableLevel;\n};\n\ntype DefaultDefineEnumOptions = {\n\tunionVariant: \"keys\";\n\twriteableLevel: \"shallow\";\n};\n\nexport const defineEnum = <\n\tconst TValue extends object,\n\tTOptions extends DefineEnumOptions = DefineEnumOptions,\n\tTComputedWriteableLevel extends WriteableLevel = [TOptions[\"writeableLevel\"]] extends [WriteableLevel] ?\n\t\tTOptions[\"writeableLevel\"]\n\t:\tDefaultDefineEnumOptions[\"writeableLevel\"],\n\tTComputedUnionVariant extends UnionVariant = [TOptions[\"unionVariant\"]] extends [UnionVariant] ?\n\t\tTOptions[\"unionVariant\"]\n\t:\tDefaultDefineEnumOptions[\"unionVariant\"],\n>(\n\tvalue: TValue,\n\t_options?: TOptions\n) => {\n\treturn value as Writeable<TValue, TComputedWriteableLevel> & {\n\t\t$inferUnion: ExtractUnion<TValue, TComputedUnionVariant>;\n\t};\n};\n\ntype DefineEnumDeepOptions = Pick<DefineEnumOptions, \"unionVariant\">;\n\nexport const defineEnumDeep = <\n\tconst TValue extends object,\n\tTOptions extends DefineEnumDeepOptions = DefineEnumDeepOptions,\n>(\n\tvalue: TValue,\n\t_options?: TOptions\n) => {\n\ttype ModifiedOptions = TOptions & { writeableLevel: \"deep\" };\n\n\treturn defineEnum<TValue, ModifiedOptions>(value);\n};\n"],"mappings":";AAOA,MAAa,YAAY,UAAmB,OAAO,UAAU;AAE7D,MAAa,YAAY,UAAmB,OAAO,UAAU;AAE7D,MAAa,YAAY,UAAmB,OAAO,UAAU;AAE7D,MAAa,aAAa,UAAmB,OAAO,UAAU;AAE9D,MAAa,WAAmB,UAAsC,MAAM,QAAQ,MAAM;AAE1F,MAAa,cAAc,UAAmB,iBAAiB;AAE/D,MAAa,YAAoC,UAChD,OAAO,UAAU,YAAY,UAAU;AAExC,MAAa,uBAAgD,UAAqC;AACjG,QAAO,SAAS,MAAM,IAAI,CAAC,QAAQ,MAAM;;AAG1C,MAAa,sBAAsB,UAAmB;AACrD,QAAO,OAAO,UAAU,SAAS,KAAK,MAAM,KAAK;;;;;;AAOlD,MAAa,iBACZ,UAC2B;AAC3B,KAAI,CAAC,mBAAmB,MAAM,CAC7B,QAAO;CAIR,MAAM,cAAe,OAA8B;AACnD,KAAI,gBAAgB,OACnB,QAAO;CAIR,MAAM,YAAY,YAAY;AAC9B,KAAI,CAAC,mBAAmB,UAAU,CACjC,QAAO;AAIR,KAAI,CAAC,OAAO,OAAO,WAAW,gBAAgB,CAC7C,QAAO;AAIR,KAAI,OAAO,eAAe,MAAM,KAAK,OAAO,UAC3C,QAAO;AAIR,QAAO;;AAGR,MAAa,cAA6C,UAAuC;AAChG,QAAO,OAAO,UAAU;;AAGzB,MAAa,mBACZ,UAC6B;AAC7B,QAAO,WAAW,MAAM,IAAI,MAAM,YAAY,SAAS;;AAGxD,MAAa,UAAU,UAAmB,iBAAiB;AAE3D,MAAa,UAAU,UAAmB,iBAAiB;AAE3D,MAAa,cAAyB,QAA4C,OAAO,YAAY;AAErG,MAAa,gBAAgB,UAAoC;AAChE,KAAI,CAAC,SAAS,MAAM,CACnB,QAAO;AAGR,KAAI;AACH,OAAK,MAAM,MAAM;AACjB,SAAO;SACA;AACP,SAAO;;;;;;AC1FT,IAAa,iBAAb,cAAoC,MAAM;CACzC,AAAS,OAAO;CAEhB,YAAY,SAAkB;AAG7B,QAAM,UAAU,qBAAc,YAAY,QAAQ;;;AAIpD,MAAa,iBAAyB,UAAkB;AACvD,KAAI,SAAS,KACZ,OAAM,IAAI,eAAe,wBAAwB,MAA0B,IAAI;AAGhF,QAAO;;AAGR,MAAa,aAAa,UAA8B,YAAqB;AAC5E,KAAI,aAAa,OAChB,OAAM,IAAI,eAAe,QAAQ;AAGlC,QAAO;;AAgBR,MAAaA,UAAoB,OAAgB,qBAA8C;AAC9F,KAAI,UAAU,SAAS,SAAS,KAG/B,OAAM,IAAI,eAFM,SAAS,iBAAiB,GAAG,mBAAmB,kBAAkB,QAEjD;;;;;ACjCnC,MAAa,cAUZ,OACA,aACI;AACJ,QAAO;;AAOR,MAAa,kBAIZ,OACA,aACI;AAGJ,QAAO,WAAoC,MAAM"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zayne-labs/toolkit-type-helpers",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.12.
|
|
4
|
+
"version": "0.12.15",
|
|
5
5
|
"description": "A collection of utility functions, types and composables used by my other projects. Nothing too fancy but can be useful.",
|
|
6
6
|
"author": "Ryan Zayne",
|
|
7
7
|
"license": "MIT",
|