is-kit 1.6.4 → 1.7.0

package/README.md

@@ -166,7 +166,7 @@ Use `not(...)` when you want the complement of an existing guard or refinement.
 Use `struct` for plain-object payloads. Keys are required by default.
 
 ```ts
-import { isNumber, isString, optionalKey, struct } from 'is-kit';
+import { isNumber, isString, optional, optionalKey, struct } from 'is-kit';
 
 const isProfile = struct(
   {
@@ -176,14 +176,6 @@ const isProfile = struct(
   },
   { exact: true }
 );
-```
-
-`optionalKey(guard)` means the property may be missing.
-
-If the property must exist but the value may be `undefined`, use `optional(guard)` instead.
-
-```ts
-import { isString, optional, optionalKey, struct } from 'is-kit';
 
 const isConfig = struct({
   label: isString,
@@ -192,6 +184,12 @@ const isConfig = struct({
 });
 ```
 
+`optionalKey(guard)` means the property may be missing.
+
+Use `struct(schema, { exact: true })` when extra keys should be rejected.
+
+If the property must exist but the value may be `undefined`, use `optional(guard)` instead.
+
 ### 5. Validate arrays, tuples, maps, sets, and records
 
 Collection combinators keep your element guards reusable.
@@ -202,12 +200,14 @@ import {
   isNumber,
   isString,
   mapOf,
+  nonEmptyArrayOf,
   recordOf,
   setOf,
   tupleOf
 } from 'is-kit';
 
 const isStringArray = arrayOf(isString);
+const isNonEmptyTagList = nonEmptyArrayOf(isString);
 const isPoint = tupleOf(isNumber, isNumber);
 const isTagSet = setOf(isString);
 const isScoreMap = mapOf(isString, isNumber);
@@ -356,7 +356,7 @@ The library is organized around a few small building blocks:
 - **Primitives**: `isString`, `isNumber`, `isBoolean`, `isInteger`, ...
 - **Composition**: `define`, `and`, `andAll`, `or`, `not`, `oneOf`
 - **Object shapes**: `struct`, `optionalKey`, `hasKey`, `hasKeys`, `narrowKeyTo`
-- **Collections**: `arrayOf`, `tupleOf`, `setOf`, `mapOf`, `recordOf`
+- **Collections**: `arrayOf`, `nonEmptyArrayOf`, `tupleOf`, `setOf`, `mapOf`, `recordOf`
 - **Literals**: `oneOfValues`, `equals`, `equalsBy`, `equalsKey`
 - **Nullish handling**: `nullable`, `nonNull`, `nullish`, `optional`, `required`
 - **Result helpers**: `safeParse`, `safeParseWith`, `assert`

package/dist/index.d.mts

@@ -324,6 +324,13 @@ declare const isPrimitive: Guard<string | number | bigint | boolean | symbol | n
  * @returns Predicate narrowing to a readonly array of the guarded element type.
  */
 declare function arrayOf<F extends Predicate<unknown>>(elementGuard: F): Predicate<readonly GuardedOf<F>[]>;
+/**
+ * Validates a non-empty array where every element satisfies the provided guard.
+ *
+ * @param elementGuard Guard applied to each array element.
+ * @returns Predicate narrowing to a readonly non-empty array of the guarded element type.
+ */
+declare function nonEmptyArrayOf<F extends Predicate<unknown>>(elementGuard: F): Predicate<readonly [GuardedOf<F>, ...GuardedOf<F>[]]>;
 
 /**
  * Validates a set where every value satisfies the provided guard.
@@ -606,4 +613,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, isFiniteNumber, isFunction, isInfiniteNumber, isInstanceOf, isInteger, isIterable, isMap, isNaN, isNegative, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPositive, isPrimitive, isPromiseLike, isRegExp, isSafeInteger, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, isWeakMap, isWeakSet, isZero, mapOf, narrowKeyTo, nonNull, not, nullable, nullish, oneOf, oneOfValues, optional, optionalKey, or, predicateToRefine, recordOf, required, safeParse, safeParseWith, setOf, struct, toBooleanPredicates, tupleOf };
+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, isFiniteNumber, isFunction, isInfiniteNumber, isInstanceOf, isInteger, isIterable, isMap, isNaN, isNegative, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPositive, isPrimitive, isPromiseLike, isRegExp, isSafeInteger, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, isWeakMap, isWeakSet, isZero, mapOf, narrowKeyTo, nonEmptyArrayOf, nonNull, not, nullable, nullish, oneOf, oneOfValues, optional, optionalKey, or, predicateToRefine, recordOf, required, safeParse, safeParseWith, setOf, struct, toBooleanPredicates, tupleOf };

package/dist/index.d.ts

@@ -324,6 +324,13 @@ declare const isPrimitive: Guard<string | number | bigint | boolean | symbol | n
  * @returns Predicate narrowing to a readonly array of the guarded element type.
  */
 declare function arrayOf<F extends Predicate<unknown>>(elementGuard: F): Predicate<readonly GuardedOf<F>[]>;
+/**
+ * Validates a non-empty array where every element satisfies the provided guard.
+ *
+ * @param elementGuard Guard applied to each array element.
+ * @returns Predicate narrowing to a readonly non-empty array of the guarded element type.
+ */
+declare function nonEmptyArrayOf<F extends Predicate<unknown>>(elementGuard: F): Predicate<readonly [GuardedOf<F>, ...GuardedOf<F>[]]>;
 
 /**
  * Validates a set where every value satisfies the provided guard.
@@ -606,4 +613,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, isFiniteNumber, isFunction, isInfiniteNumber, isInstanceOf, isInteger, isIterable, isMap, isNaN, isNegative, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPositive, isPrimitive, isPromiseLike, isRegExp, isSafeInteger, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, isWeakMap, isWeakSet, isZero, mapOf, narrowKeyTo, nonNull, not, nullable, nullish, oneOf, oneOfValues, optional, optionalKey, or, predicateToRefine, recordOf, required, safeParse, safeParseWith, setOf, struct, toBooleanPredicates, tupleOf };
+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, isFiniteNumber, isFunction, isInfiniteNumber, isInstanceOf, isInteger, isIterable, isMap, isNaN, isNegative, isNull, isNumber, isNumberPrimitive, isObject, isPlainObject, isPositive, isPrimitive, isPromiseLike, isRegExp, isSafeInteger, isSet, isString, isSymbol, isTypedArray, isURL, isUndefined, isWeakMap, isWeakSet, isZero, mapOf, narrowKeyTo, nonEmptyArrayOf, nonNull, not, nullable, nullish, oneOf, oneOfValues, optional, optionalKey, or, predicateToRefine, recordOf, required, safeParse, safeParseWith, setOf, struct, toBooleanPredicates, tupleOf };

package/dist/index.js

@@ -75,6 +75,7 @@ __export(index_exports, {
   isZero: () => isZero,
   mapOf: () => mapOf,
   narrowKeyTo: () => narrowKeyTo,
+  nonEmptyArrayOf: () => nonEmptyArrayOf,
   nonNull: () => nonNull,
   not: () => not,
   nullable: () => nullable,
@@ -352,6 +353,11 @@ function arrayOf(elementGuard) {
     (input) => Array.isArray(input) && everyArrayValue(input, elementGuard)
   );
 }
+function nonEmptyArrayOf(elementGuard) {
+  return define(
+    (input) => Array.isArray(input) && input.length > 0 && everyArrayValue(input, elementGuard)
+  );
+}
 
 // src/core/combinators/set.ts
 function setOf(valueGuard) {
@@ -541,6 +547,7 @@ function narrowKeyTo(guard, key) {
   isZero,
   mapOf,
   narrowKeyTo,
+  nonEmptyArrayOf,
   nonNull,
   not,
   nullable,

package/dist/index.mjs

@@ -254,6 +254,11 @@ function arrayOf(elementGuard) {
     (input) => Array.isArray(input) && everyArrayValue(input, elementGuard)
   );
 }
+function nonEmptyArrayOf(elementGuard) {
+  return define(
+    (input) => Array.isArray(input) && input.length > 0 && everyArrayValue(input, elementGuard)
+  );
+}
 
 // src/core/combinators/set.ts
 function setOf(valueGuard) {
@@ -442,6 +447,7 @@ export {
   isZero,
   mapOf,
   narrowKeyTo,
+  nonEmptyArrayOf,
   nonNull,
   not,
   nullable,

package/package.json

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