is-kit 1.11.1 → 1.11.2

package/dist/index.d.mts

@@ -63,6 +63,34 @@ type InferSchema<S extends SchemaShape<S>> = Simplify<{
 } & {
     readonly [K in OptionalSchemaKeys<S>]?: InferSchemaField<S[K]>;
 }>;
+/**
+ * Extracts optional keys from an object type.
+ */
+type OptionalObjectKeys<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? K : never;
+}[keyof T];
+/**
+ * Extracts required keys from an object type.
+ */
+type RequiredObjectKeys<T> = Exclude<keyof T, OptionalObjectKeys<T>>;
+/**
+ * Schema shape checked against an existing object type by `typedStruct`.
+ */
+type TypedStructShape<T extends object> = {
+    readonly [K in Extract<RequiredObjectKeys<T>, string>]-?: Predicate<T[K]>;
+} & {
+    readonly [K in Extract<OptionalObjectKeys<T>, string>]-?: OptionalSchemaField<Predicate<T[K]>>;
+};
+/**
+ * Keeps a schema type while rejecting keys outside the expected shape.
+ */
+type NoExtraKeys<S, Shape> = S & {
+    readonly [K in Exclude<keyof S, keyof Shape>]: never;
+};
+/**
+ * Field set accepted by `typedStruct` for a target object type.
+ */
+type TypedStructFields<T extends object, S extends TypedStructShape<T>> = NoExtraKeys<S, TypedStructShape<T>>;
 
 /**
  * Asserts that a value satisfies a guard or refinement, otherwise throws.
@@ -662,19 +690,6 @@ declare function struct<const S extends SchemaShape<S>>(schema: S, options?: {
     exact?: boolean;
 }): Predicate<InferSchema<S>>;
 
-type OptionalKeys<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? K : never;
-}[keyof T];
-type RequiredKeys<T> = Exclude<keyof T, OptionalKeys<T>>;
-type TypedStructShape<T extends object> = {
-    readonly [K in Extract<RequiredKeys<T>, string>]-?: Predicate<T[K]>;
-} & {
-    readonly [K in Extract<OptionalKeys<T>, string>]-?: OptionalSchemaField<Predicate<T[K]>>;
-};
-type NoExtraKeys<S, Shape> = S & {
-    readonly [K in Exclude<keyof S, keyof Shape>]: never;
-};
-type TypedStructFields<T extends object, S extends TypedStructShape<T>> = NoExtraKeys<S, TypedStructShape<T>>;
 /**
  * Creates a `struct` builder checked against an existing object type.
  * Optional target keys must also be declared with `optionalKey` so type drift
@@ -748,4 +763,4 @@ declare const everyOwnEnumerableEntry: (values: Record<string, unknown>, keyPred
  */
 declare const toBooleanPredicates: <A>(predicates: readonly ((value: A) => boolean)[]) => ReadonlyArray<(value: A) => boolean>;
 
-export { type ChainResult, type Guard, type GuardedOf, type GuardedWithin, type InferSchema, type OptionalSchemaField, type OutOfGuards, type ParseResult, type Predicate, type Primitive, type Refine, type RefineChain, type Refinement, type Schema, type SchemaField, and, andAll, arrayOf, assert, define, equals, equalsBy, equalsKey, everyArrayValue, everyMapEntry, everyOwnEnumerableEntry, everySetValue, everyTupleValue, guardIn, hasKey, hasKeys, isArray, isArrayBuffer, isAsyncIterable, isBigInt, isBlob, isBoolean, isDataView, isDate, isError, isFile, isFiniteNumber, isFunction, isInfiniteNumber, isInstanceOf, isInteger, isIterable, isMap, isNaN, isNegative, isNil, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPositive, isPrimitive, isPromiseLike, isRegExp, isSafeInteger, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, isWeakMap, isWeakSet, isZero, lazy, mapOf, narrowKeyTo, nonEmptyArrayOf, nonNull, not, nullable, nullish, oneOf, oneOfValues, optional, optionalKey, or, predicateToRefine, recordOf, required, safeJsonParse, safeParse, safeParseWith, setOf, struct, toBooleanPredicates, tupleOf, typedStruct };
+export { type ChainResult, type Guard, type GuardedOf, type GuardedWithin, type InferSchema, type NoExtraKeys, type OptionalObjectKeys, type OptionalSchemaField, type OutOfGuards, type ParseResult, type Predicate, type Primitive, type Refine, type RefineChain, type Refinement, type RequiredObjectKeys, type Schema, type SchemaField, type TypedStructFields, type TypedStructShape, and, andAll, arrayOf, assert, define, equals, equalsBy, equalsKey, everyArrayValue, everyMapEntry, everyOwnEnumerableEntry, everySetValue, everyTupleValue, guardIn, hasKey, hasKeys, isArray, isArrayBuffer, isAsyncIterable, isBigInt, isBlob, isBoolean, isDataView, isDate, isError, isFile, isFiniteNumber, isFunction, isInfiniteNumber, isInstanceOf, isInteger, isIterable, isMap, isNaN, isNegative, isNil, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPositive, isPrimitive, isPromiseLike, isRegExp, isSafeInteger, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, isWeakMap, isWeakSet, isZero, lazy, mapOf, narrowKeyTo, nonEmptyArrayOf, nonNull, not, nullable, nullish, oneOf, oneOfValues, optional, optionalKey, or, predicateToRefine, recordOf, required, safeJsonParse, safeParse, safeParseWith, setOf, struct, toBooleanPredicates, tupleOf, typedStruct };

package/dist/index.d.ts

@@ -63,6 +63,34 @@ type InferSchema<S extends SchemaShape<S>> = Simplify<{
 } & {
     readonly [K in OptionalSchemaKeys<S>]?: InferSchemaField<S[K]>;
 }>;
+/**
+ * Extracts optional keys from an object type.
+ */
+type OptionalObjectKeys<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? K : never;
+}[keyof T];
+/**
+ * Extracts required keys from an object type.
+ */
+type RequiredObjectKeys<T> = Exclude<keyof T, OptionalObjectKeys<T>>;
+/**
+ * Schema shape checked against an existing object type by `typedStruct`.
+ */
+type TypedStructShape<T extends object> = {
+    readonly [K in Extract<RequiredObjectKeys<T>, string>]-?: Predicate<T[K]>;
+} & {
+    readonly [K in Extract<OptionalObjectKeys<T>, string>]-?: OptionalSchemaField<Predicate<T[K]>>;
+};
+/**
+ * Keeps a schema type while rejecting keys outside the expected shape.
+ */
+type NoExtraKeys<S, Shape> = S & {
+    readonly [K in Exclude<keyof S, keyof Shape>]: never;
+};
+/**
+ * Field set accepted by `typedStruct` for a target object type.
+ */
+type TypedStructFields<T extends object, S extends TypedStructShape<T>> = NoExtraKeys<S, TypedStructShape<T>>;
 
 /**
  * Asserts that a value satisfies a guard or refinement, otherwise throws.
@@ -662,19 +690,6 @@ declare function struct<const S extends SchemaShape<S>>(schema: S, options?: {
     exact?: boolean;
 }): Predicate<InferSchema<S>>;
 
-type OptionalKeys<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? K : never;
-}[keyof T];
-type RequiredKeys<T> = Exclude<keyof T, OptionalKeys<T>>;
-type TypedStructShape<T extends object> = {
-    readonly [K in Extract<RequiredKeys<T>, string>]-?: Predicate<T[K]>;
-} & {
-    readonly [K in Extract<OptionalKeys<T>, string>]-?: OptionalSchemaField<Predicate<T[K]>>;
-};
-type NoExtraKeys<S, Shape> = S & {
-    readonly [K in Exclude<keyof S, keyof Shape>]: never;
-};
-type TypedStructFields<T extends object, S extends TypedStructShape<T>> = NoExtraKeys<S, TypedStructShape<T>>;
 /**
  * Creates a `struct` builder checked against an existing object type.
  * Optional target keys must also be declared with `optionalKey` so type drift
@@ -748,4 +763,4 @@ declare const everyOwnEnumerableEntry: (values: Record<string, unknown>, keyPred
  */
 declare const toBooleanPredicates: <A>(predicates: readonly ((value: A) => boolean)[]) => ReadonlyArray<(value: A) => boolean>;
 
-export { type ChainResult, type Guard, type GuardedOf, type GuardedWithin, type InferSchema, type OptionalSchemaField, type OutOfGuards, type ParseResult, type Predicate, type Primitive, type Refine, type RefineChain, type Refinement, type Schema, type SchemaField, and, andAll, arrayOf, assert, define, equals, equalsBy, equalsKey, everyArrayValue, everyMapEntry, everyOwnEnumerableEntry, everySetValue, everyTupleValue, guardIn, hasKey, hasKeys, isArray, isArrayBuffer, isAsyncIterable, isBigInt, isBlob, isBoolean, isDataView, isDate, isError, isFile, isFiniteNumber, isFunction, isInfiniteNumber, isInstanceOf, isInteger, isIterable, isMap, isNaN, isNegative, isNil, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPositive, isPrimitive, isPromiseLike, isRegExp, isSafeInteger, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, isWeakMap, isWeakSet, isZero, lazy, mapOf, narrowKeyTo, nonEmptyArrayOf, nonNull, not, nullable, nullish, oneOf, oneOfValues, optional, optionalKey, or, predicateToRefine, recordOf, required, safeJsonParse, safeParse, safeParseWith, setOf, struct, toBooleanPredicates, tupleOf, typedStruct };
+export { type ChainResult, type Guard, type GuardedOf, type GuardedWithin, type InferSchema, type NoExtraKeys, type OptionalObjectKeys, type OptionalSchemaField, type OutOfGuards, type ParseResult, type Predicate, type Primitive, type Refine, type RefineChain, type Refinement, type RequiredObjectKeys, type Schema, type SchemaField, type TypedStructFields, type TypedStructShape, and, andAll, arrayOf, assert, define, equals, equalsBy, equalsKey, everyArrayValue, everyMapEntry, everyOwnEnumerableEntry, everySetValue, everyTupleValue, guardIn, hasKey, hasKeys, isArray, isArrayBuffer, isAsyncIterable, isBigInt, isBlob, isBoolean, isDataView, isDate, isError, isFile, isFiniteNumber, isFunction, isInfiniteNumber, isInstanceOf, isInteger, isIterable, isMap, isNaN, isNegative, isNil, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPositive, isPrimitive, isPromiseLike, isRegExp, isSafeInteger, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, isWeakMap, isWeakSet, isZero, lazy, mapOf, narrowKeyTo, nonEmptyArrayOf, nonNull, not, nullable, nullish, oneOf, oneOfValues, optional, optionalKey, or, predicateToRefine, recordOf, required, safeJsonParse, safeParse, safeParseWith, setOf, struct, toBooleanPredicates, tupleOf, typedStruct };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "is-kit",
-  "version": "1.11.1",
+  "version": "1.11.2",
   "description": "Make 'isXXX' easier. Let's make your code type safe and more readable!",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",