@jakobkg/shapes-ts 0.3.0 → 0.3.1

package/README.md

@@ -6,9 +6,11 @@ When describing the shape of your data in shapes-ts, you get the corresponding
 TS type and a validation utility for free!
 
 ```typescript
-const Role = Shapes.object({
-  role: Shapes.string(),
-  actor: Shapes.string(),
+const CreditCategory = Shapes.enum(["director", "writer", "actor/actress"])
+
+const Credits = Shapes.object({
+  category: CreditCategory,
+  name: Shapes.string(),
 });
 
 const Movie = Shapes.object({
@@ -17,14 +19,17 @@ const Movie = Shapes.object({
     (n) => n >= 0 && n <= 5,
     "rating must be in range 0.0-5.0",
   ),
-  cast: Shapes.array(Role),
+  credits: Shapes.array(Credits),
 });
 
 // This infers as
 // {
 //   title: string,
 //   rating: number,
-//   cast: { role: string, actor: string }[]
+//   credits: {
+//     category: "director" | "writer" | "actor/actress",
+//     name: string
+//   }[]
 // }
 type Movie = Shapes.Type<typeof Movie>;
 
@@ -55,6 +60,8 @@ for (const member of movieData.cast) {
 
 - object
 - array
+- tuple
+- enum
 
 ### Modified types
 

package/dist/shapes.d.ts

@@ -45,6 +45,14 @@ export declare function string(): Shape<string>;
  */
 export declare function boolean(): Shape<boolean>;
 type Primitive = number | string | boolean | null | undefined;
+/**
+ * Creates a shape representing a primitive literal type.
+ * Takes numbers, strings, booleans, null and undefined.
+ *
+ * The resulting shape is equivalent to the type you would
+ * get when doing something like `const one = 1 as const;`,
+ * where the type is just the literal `1`
+ */
 export declare function literal<T extends Primitive>(x: T): Shape<T>;
 /**
  * Creates an array shape, representing `Array<T>` (aka `T[]`).
@@ -73,11 +81,23 @@ export declare function array<T>(shape: Shape<T>): Shape<T[]>;
 export declare function object<T extends Record<string, Shape<any>>>(properties: T, options?: ObjectShapeOptions): ObjectShape<{
     [K in keyof T]: Type<T[K]>;
 }>;
+/**
+ * Creates a shape representing a tuple type, with an optional rest
+ *
+ * Shapes.tuple([Shapes.number(), Shape.string()]) is equivalent to TS type [number, string]
+ * Shapes.tuple([Shapes.number()], Shapes.string()) is equivalent to TS type [number, ...string]
+ */
 export declare function tuple<Shapes extends Shape<any>[], Partial extends {
     [K in keyof Shapes]: Type<Shapes[K]>;
 }, Tuple extends RestShape extends Shape<infer Rest> ? [...Partial, ...Rest[]] : [...Partial], RestShape extends Shape<any> | undefined = undefined>(shapes: [...Shapes], rest?: RestShape): Shape<Tuple>;
 export { enumOf as enum };
-declare function enumOf<T extends (string | number)[]>(...values: T): Shape<T[number]>;
+/**
+ * Creates a shape representing an enum type
+ * (Not an actual enum as made using the enum keyword)
+ *
+ * `Shapes.enum(["a", "b", "c"])` is equivalent to `"a" | "b" | "c"`
+ */
+declare function enumOf<T extends (string | number)[]>(values: [...T]): Shape<T[number]>;
 /**
  * Creates a shape representing an optional type.
  * `Shapes.optional(T)` corresponds to `T | undefined`

package/dist/shapes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shapes.d.ts","sourceRoot":"","sources":["../src/shapes/shapes.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,UAAU,eAAW,CAAC;AAC5B,QAAA,MAAM,UAAU,eAAW,CAAC;AAC5B,QAAA,MAAM,sBAAsB,eAAW,CAAC;AAgCxC;;GAEG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAG3D,KAAK,cAAc,CAAC,CAAC,IAAI;IACvB,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC,CAAC;AAGF,UAAU,KAAK,CAAC,CAAC;IACf,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IAE3C,KAAK,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC;IAE1B;;;;;OAKG;IACH,KAAK,CACH,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO,EAC5B,WAAW,EAAE,MAAM,GAAG,SAAS,GAC9B,KAAK,CAAC,CAAC,CAAC,CAAC;IAEZ,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACtC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;CACtC;AAGD,UAAU,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAE,SAAQ,KAAK,CAAC,CAAC,CAAC;IACjE,QAAQ,CAAC,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,QAAQ,CAAC,CAAC,sBAAsB,CAAC,CAAC,EAAE,OAAO,CAAC;CAC7C;AAED,UAAU,kBAAkB;IAC1B,QAAQ,CAAC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAC1C,QAAQ,CAAC,6BAA6B,CAAC,EAAE,MAAM,CAC7C,MAAM,EACN,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAC/B,CAAC;CACH;AA+ED;;;GAGG;AACH,wBAAgB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAuBtC;AAED;;GAEG;AACH,wBAAgB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAsBtC;AAED;;GAEG;AACH,wBAAgB,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,CAsBxC;AAED,KAAK,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;AAE9D,wBAAgB,OAAO,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CA4B3D;AAID;;;GAGG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CA6BpD;AAED;;;;;;;;;;;;;;;;;;GAkBG;AAEH,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,EACzD,UAAU,EAAE,CAAC,EACb,OAAO,CAAC,EAAE,kBAAkB,GAC3B,WAAW,CACZ;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3B,CACF,CAgEA;AAED,wBAAgB,KAAK,CAEnB,MAAM,SAAS,KAAK,CAAC,GAAG,CAAC,EAAE,EAC3B,OAAO,SAAS;KAAG,CAAC,IAAI,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAAE,EACxD,KAAK,SAAS,SAAS,SAAS,KAAK,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC,GACvE,CAAC,GAAG,OAAO,CAAC,EAEhB,SAAS,SAAS,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,GAAG,SAAS,EACpD,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,CAkCrD;AAED,OAAO,EAAE,MAAM,IAAI,IAAI,EAAE,CAAC;AAC1B,iBAAS,MAAM,CAAC,CAAC,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAuB7E;AAID;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC,CAEjE;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAE5D"}
+{"version":3,"file":"shapes.d.ts","sourceRoot":"","sources":["../src/shapes/shapes.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,UAAU,eAAW,CAAC;AAC5B,QAAA,MAAM,UAAU,eAAW,CAAC;AAC5B,QAAA,MAAM,sBAAsB,eAAW,CAAC;AAgCxC;;GAEG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAG3D,KAAK,cAAc,CAAC,CAAC,IAAI;IACvB,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC,CAAC;AAGF,UAAU,KAAK,CAAC,CAAC;IACf,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IAE3C,KAAK,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC;IAE1B;;;;;OAKG;IACH,KAAK,CACH,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO,EAC5B,WAAW,EAAE,MAAM,GAAG,SAAS,GAC9B,KAAK,CAAC,CAAC,CAAC,CAAC;IAEZ,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACtC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;CACtC;AAGD,UAAU,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAE,SAAQ,KAAK,CAAC,CAAC,CAAC;IACjE,QAAQ,CAAC,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,QAAQ,CAAC,CAAC,sBAAsB,CAAC,CAAC,EAAE,OAAO,CAAC;CAC7C;AAED,UAAU,kBAAkB;IAC1B,QAAQ,CAAC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAC1C,QAAQ,CAAC,6BAA6B,CAAC,EAAE,MAAM,CAC7C,MAAM,EACN,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAC/B,CAAC;CACH;AA+ED;;;GAGG;AACH,wBAAgB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAuBtC;AAED;;GAEG;AACH,wBAAgB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAsBtC;AAED;;GAEG;AACH,wBAAgB,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,CAsBxC;AAED,KAAK,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;AAE9D;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CA4B3D;AAID;;;GAGG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CA6BpD;AAED;;;;;;;;;;;;;;;;;;GAkBG;AAEH,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,EACzD,UAAU,EAAE,CAAC,EACb,OAAO,CAAC,EAAE,kBAAkB,GAC3B,WAAW,CACZ;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3B,CACF,CAgEA;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAEnB,MAAM,SAAS,KAAK,CAAC,GAAG,CAAC,EAAE,EAC3B,OAAO,SAAS;KAAG,CAAC,IAAI,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAAE,EACxD,KAAK,SAAS,SAAS,SAAS,KAAK,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC,GACvE,CAAC,GAAG,OAAO,CAAC,EAEhB,SAAS,SAAS,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,GAAG,SAAS,EACpD,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,CAmCrD;AAED,OAAO,EAAE,MAAM,IAAI,IAAI,EAAE,CAAC;AAC1B;;;;;GAKG;AACH,iBAAS,MAAM,CAAC,CAAC,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAuB/E;AAID;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC,CAEjE;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAE5D"}

package/dist/shapes.js

@@ -178,6 +178,14 @@ function boolean() {
         },
         _a;
 }
+/**
+ * Creates a shape representing a primitive literal type.
+ * Takes numbers, strings, booleans, null and undefined.
+ *
+ * The resulting shape is equivalent to the type you would
+ * get when doing something like `const one = 1 as const;`,
+ * where the type is just the literal `1`
+ */
 function literal(x) {
     var _a;
     function matchesLiteral(u) {
@@ -187,9 +195,9 @@ function literal(x) {
             typename: isUndefined(x) ? "undefined" : JSON.stringify(x)
         },
         _a[Predicates] = [],
-        _a.check = function (input) {
-            return matchesLiteral(input) &&
-                this[Predicates].every(function (p) { return p.predicate(input); });
+        _a.check = function (x) {
+            return matchesLiteral(x) &&
+                this[Predicates].every(function (p) { return p.predicate(x); });
         },
         _a.where = function (predicate, description) {
             var _a;
@@ -213,12 +221,12 @@ function array(shape) {
     var typename = "Array<".concat(shape.typename, ">");
     return _a = {
             typename: typename,
-            check: function (input) {
+            check: function (x) {
                 function innerMatches(x) {
                     return x.every(function (entry) { return shape.check(entry); });
                 }
-                return isArray(input) && innerMatches(input) &&
-                    this[Predicates].every(function (p) { return p.predicate(input); });
+                return isArray(x) && innerMatches(x) &&
+                    this[Predicates].every(function (p) { return p.predicate(x); });
             }
         },
         _a[Predicates] = [],
@@ -262,7 +270,7 @@ function object(properties, options) {
             typename: "Object"
         },
         _a[AllowUnknownProperties] = allowUnknownProperties,
-        _a.check = function (input) {
+        _a.check = function (x) {
             var _this = this;
             var matchesShape = function (input) {
                 // Check that input is an object
@@ -294,8 +302,8 @@ function object(properties, options) {
                 }
                 return true;
             };
-            return matchesShape(input) &&
-                this[Predicates].every(function (p) { return p.predicate(input); });
+            return matchesShape(x) &&
+                this[Predicates].every(function (p) { return p.predicate(x); });
         },
         _a[Properties] = __assign(__assign({}, properties), options === null || options === void 0 ? void 0 : options.additionalPermittedProperties),
         _a[Predicates] = [],
@@ -311,6 +319,12 @@ function object(properties, options) {
         },
         _a;
 }
+/**
+ * Creates a shape representing a tuple type, with an optional rest
+ *
+ * Shapes.tuple([Shapes.number(), Shape.string()]) is equivalent to TS type [number, string]
+ * Shapes.tuple([Shapes.number()], Shapes.string()) is equivalent to TS type [number, ...string]
+ */
 function tuple(shapes, rest) {
     var _a;
     var typename = "[".concat(shapes.map(function (s) { return s.typename; }).join(", "), "]");
@@ -321,15 +335,16 @@ function tuple(shapes, rest) {
         _a.check = function (x) {
             if (!isArray(x))
                 return false;
-            var xMightHaveRest = x.length > shapes.length;
-            var haveRestShape = rest !== undefined;
-            if (haveRestShape && xMightHaveRest) {
+            if (x.length > shapes.length) {
+                // Oversized x and no rest shape can't be valid 
+                if (rest === undefined)
+                    return false;
                 for (var idx = shapes.length; idx < x.length; idx++) {
                     if (!rest.check(x[idx]))
                         return false;
                 }
             }
-            return shapes.every(function (shape, idx) { return shape.check(x[idx]); });
+            return shapes.every(function (shape, idx) { return shape.check(x[idx]); }) && this[Predicates].every(function (p) { return p.predicate(x); });
         },
         _a.where = function (predicate, description) {
             var _a;
@@ -343,18 +358,20 @@ function tuple(shapes, rest) {
         },
         _a;
 }
-function enumOf() {
+/**
+ * Creates a shape representing an enum type
+ * (Not an actual enum as made using the enum keyword)
+ *
+ * `Shapes.enum(["a", "b", "c"])` is equivalent to `"a" | "b" | "c"`
+ */
+function enumOf(values) {
     var _a;
-    var values = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        values[_i] = arguments[_i];
-    }
     return _a = {
             typename: "".concat(values.map(function (v) { return JSON.stringify(v); }).join(" | "))
         },
         _a[Predicates] = [],
         _a.check = function (x) {
-            return (isNumber(x) || isString(x)) && values.includes(x);
+            return (isNumber(x) || isString(x)) && values.includes(x) && this[Predicates].every(function (p) { return p.predicate(x); });
         },
         _a.where = function (predicate, description) {
             var _a;

package/package.json

@@ -6,7 +6,7 @@
   },
   "homepage": "https://codeberg.org/jakobkg/shapes-ts#readme",
   "license": "BSD-3-Clause",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "private": false,
   "main": "dist/index.js",
   "scripts": {