superstruct - npm Package Compare versions

Comparing version 0.10.11 to 0.10.12

lib/index.cjs.d.ts

@@ -284,2 +284,38 @@ /**
 declare function number(): Struct<number>; /**
+ * Type helper to Flatten the Union of optional and required properties.
+ */
+/**
+ * Type helper to Flatten the Union of optional and required properties.
+ */
+type Flatten<T> = T extends infer U ? {
+    [K in keyof U]: U[K];
+} : never; /**
+ * Type helper to extract the optional keys of an object
+ */
+/**
+ * Type helper to extract the optional keys of an object
+ */
+type OptionalKeys<T> = {
+    [K in keyof T]: undefined extends T[K] ? K : never;
+}[keyof T]; /**
+ * Type helper to extract the required keys of an object
+ */
+/**
+ * Type helper to extract the required keys of an object
+ */
+type RequiredKeys<T> = {
+    [K in keyof T]: undefined extends T[K] ? never : K;
+}[keyof T]; /**
+ * Type helper to create optional properties when the property value can be
+ * undefined (ie. when `optional()` is used to define a type)
+ */
+/**
+ * Type helper to create optional properties when the property value can be
+ * undefined (ie. when `optional()` is used to define a type)
+ */
+type OptionalizeObject<T> = Flatten<{
+    [K in RequiredKeys<T>]: T[K];
+} & {
+    [K in OptionalKeys<T>]?: T[K];
+}>; /**
  * Validate that an object with specific entry values.
@@ -291,5 +327,5 @@ */
 declare function object<V extends StructRecord<any>>(): Struct<Record<string, unknown>>;
-declare function object<V extends StructRecord<any>>(Structs: V): Struct<{
+declare function object<V extends StructRecord<any>>(Structs: V): Struct<OptionalizeObject<{
     [K in keyof V]: StructType<V[K]>;
-}, V>;
+}>, V>;
 /**
@@ -296,0 +332,0 @@ * Augment a struct to make it optionally accept `undefined` values.

lib/index.es.d.ts

@@ -284,2 +284,38 @@ /**
 declare function number(): Struct<number>; /**
+ * Type helper to Flatten the Union of optional and required properties.
+ */
+/**
+ * Type helper to Flatten the Union of optional and required properties.
+ */
+type Flatten<T> = T extends infer U ? {
+    [K in keyof U]: U[K];
+} : never; /**
+ * Type helper to extract the optional keys of an object
+ */
+/**
+ * Type helper to extract the optional keys of an object
+ */
+type OptionalKeys<T> = {
+    [K in keyof T]: undefined extends T[K] ? K : never;
+}[keyof T]; /**
+ * Type helper to extract the required keys of an object
+ */
+/**
+ * Type helper to extract the required keys of an object
+ */
+type RequiredKeys<T> = {
+    [K in keyof T]: undefined extends T[K] ? never : K;
+}[keyof T]; /**
+ * Type helper to create optional properties when the property value can be
+ * undefined (ie. when `optional()` is used to define a type)
+ */
+/**
+ * Type helper to create optional properties when the property value can be
+ * undefined (ie. when `optional()` is used to define a type)
+ */
+type OptionalizeObject<T> = Flatten<{
+    [K in RequiredKeys<T>]: T[K];
+} & {
+    [K in OptionalKeys<T>]?: T[K];
+}>; /**
  * Validate that an object with specific entry values.
@@ -291,5 +327,5 @@ */
 declare function object<V extends StructRecord<any>>(): Struct<Record<string, unknown>>;
-declare function object<V extends StructRecord<any>>(Structs: V): Struct<{
+declare function object<V extends StructRecord<any>>(Structs: V): Struct<OptionalizeObject<{
     [K in keyof V]: StructType<V[K]>;
-}, V>;
+}>, V>;
 /**
@@ -296,0 +332,0 @@ * Augment a struct to make it optionally accept `undefined` values.

lib/types.d.ts

@@ -92,8 +92,35 @@ import { Struct, StructType, StructContext } from './struct';
 /**
+ * Type helper to Flatten the Union of optional and required properties.
+ */
+declare type Flatten<T> = T extends infer U ? {
+    [K in keyof U]: U[K];
+} : never;
+/**
+ * Type helper to extract the optional keys of an object
+ */
+declare type OptionalKeys<T> = {
+    [K in keyof T]: undefined extends T[K] ? K : never;
+}[keyof T];
+/**
+ * Type helper to extract the required keys of an object
+ */
+declare type RequiredKeys<T> = {
+    [K in keyof T]: undefined extends T[K] ? never : K;
+}[keyof T];
+/**
+ * Type helper to create optional properties when the property value can be
+ * undefined (ie. when `optional()` is used to define a type)
+ */
+declare type OptionalizeObject<T> = Flatten<{
+    [K in RequiredKeys<T>]: T[K];
+} & {
+    [K in OptionalKeys<T>]?: T[K];
+}>;
+/**
  * Validate that an object with specific entry values.
  */
 export declare function object<V extends StructRecord<any>>(): Struct<Record<string, unknown>>;
-export declare function object<V extends StructRecord<any>>(Structs: V): Struct<{
+export declare function object<V extends StructRecord<any>>(Structs: V): Struct<OptionalizeObject<{
     [K in keyof V]: StructType<V[K]>;
-}, V>;
+}>, V>;
 /**
@@ -173,2 +200,3 @@ * Augment a struct to make it optionally accept `undefined` values.
 export declare function union<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q>(Structs: StructTuple<[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q]>): Struct<A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q>;
+export {};
 //# sourceMappingURL=types.d.ts.map

package.json

@@ -5,3 +5,3 @@ {
   "description": "A simple, expressive way to validate data in JavaScript.",
-  "version": "0.10.11",
+  "version": "0.10.12",
   "license": "MIT",
@@ -41,3 +41,3 @@ "repository": "git://github.com/ianstormtaylor/superstruct.git",
     "lodash": "^4.17.15",
-    "mocha": "^7.2.0",
+    "mocha": "^8.0.1",
     "prettier": "^2.0.5",
@@ -71,3 +71,4 @@ "rollup": "^2.12.0",
     "test:types": "tsc --noEmit && tsc --project ./test/tsconfig.json --noEmit",
-    "watch": "yarn build:cjs --watch"
+    "watch": "yarn build:cjs --watch",
+    "watch:types": "yarn build:types --watch"
   },
@@ -74,0 +75,0 @@ "keywords": [

Readme.md

@@ -50,3 +50,3 @@ <p align="center">
 ```js
-import { assert, object, number, string, boolean, array } from 'superstruct'
+import { assert, object, number, string, array } from 'superstruct'
 
@@ -106,3 +106,3 @@ const Article = object({
 ```ts
-import { assert, coerce, object, number, string, defaulted } from 'superstruct'
+import { coerce, object, number, string, defaulted } from 'superstruct'
 
@@ -109,0 +109,0 @@ const User = object({

umd/superstruct.d.ts

@@ -284,2 +284,38 @@ /**
 declare function number(): Struct<number>; /**
+ * Type helper to Flatten the Union of optional and required properties.
+ */
+/**
+ * Type helper to Flatten the Union of optional and required properties.
+ */
+type Flatten<T> = T extends infer U ? {
+    [K in keyof U]: U[K];
+} : never; /**
+ * Type helper to extract the optional keys of an object
+ */
+/**
+ * Type helper to extract the optional keys of an object
+ */
+type OptionalKeys<T> = {
+    [K in keyof T]: undefined extends T[K] ? K : never;
+}[keyof T]; /**
+ * Type helper to extract the required keys of an object
+ */
+/**
+ * Type helper to extract the required keys of an object
+ */
+type RequiredKeys<T> = {
+    [K in keyof T]: undefined extends T[K] ? never : K;
+}[keyof T]; /**
+ * Type helper to create optional properties when the property value can be
+ * undefined (ie. when `optional()` is used to define a type)
+ */
+/**
+ * Type helper to create optional properties when the property value can be
+ * undefined (ie. when `optional()` is used to define a type)
+ */
+type OptionalizeObject<T> = Flatten<{
+    [K in RequiredKeys<T>]: T[K];
+} & {
+    [K in OptionalKeys<T>]?: T[K];
+}>; /**
  * Validate that an object with specific entry values.
@@ -291,5 +327,5 @@ */
 declare function object<V extends StructRecord<any>>(): Struct<Record<string, unknown>>;
-declare function object<V extends StructRecord<any>>(Structs: V): Struct<{
+declare function object<V extends StructRecord<any>>(Structs: V): Struct<OptionalizeObject<{
     [K in keyof V]: StructType<V[K]>;
-}, V>;
+}>, V>;
 /**
@@ -296,0 +332,0 @@ * Augment a struct to make it optionally accept `undefined` values.

umd/superstruct.min.d.ts

@@ -284,2 +284,38 @@ /**
 declare function number(): Struct<number>; /**
+ * Type helper to Flatten the Union of optional and required properties.
+ */
+/**
+ * Type helper to Flatten the Union of optional and required properties.
+ */
+type Flatten<T> = T extends infer U ? {
+    [K in keyof U]: U[K];
+} : never; /**
+ * Type helper to extract the optional keys of an object
+ */
+/**
+ * Type helper to extract the optional keys of an object
+ */
+type OptionalKeys<T> = {
+    [K in keyof T]: undefined extends T[K] ? K : never;
+}[keyof T]; /**
+ * Type helper to extract the required keys of an object
+ */
+/**
+ * Type helper to extract the required keys of an object
+ */
+type RequiredKeys<T> = {
+    [K in keyof T]: undefined extends T[K] ? never : K;
+}[keyof T]; /**
+ * Type helper to create optional properties when the property value can be
+ * undefined (ie. when `optional()` is used to define a type)
+ */
+/**
+ * Type helper to create optional properties when the property value can be
+ * undefined (ie. when `optional()` is used to define a type)
+ */
+type OptionalizeObject<T> = Flatten<{
+    [K in RequiredKeys<T>]: T[K];
+} & {
+    [K in OptionalKeys<T>]?: T[K];
+}>; /**
  * Validate that an object with specific entry values.
@@ -291,5 +327,5 @@ */
 declare function object<V extends StructRecord<any>>(): Struct<Record<string, unknown>>;
-declare function object<V extends StructRecord<any>>(Structs: V): Struct<{
+declare function object<V extends StructRecord<any>>(Structs: V): Struct<OptionalizeObject<{
     [K in keyof V]: StructType<V[K]>;
-}, V>;
+}>, V>;
 /**
@@ -296,0 +332,0 @@ * Augment a struct to make it optionally accept `undefined` values.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

384338

increased by21.04%

Number of package files

48

increased by50%

Lines of code

4842

increased by15.73%

No dependency changes