vaderjs 1.1.1 → 1.1.2

package/website/node_modules/ts-interface-checker/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/website/node_modules/ts-interface-checker/README.md

@@ -0,0 +1,185 @@
+# ts-interface-checker
+
+[![Build Status](https://travis-ci.org/gristlabs/ts-interface-checker.svg?branch=master)](https://travis-ci.org/gristlabs/ts-interface-checker)
+[![npm version](https://badge.fury.io/js/ts-interface-checker.svg)](https://badge.fury.io/js/ts-interface-checker)
+
+
+> Runtime library to validate data against TypeScript interfaces.
+
+This package is the runtime support for validators created by
+[ts-interface-builder](https://github.com/gristlabs/ts-interface-builder).
+It allows validating data, such as parsed JSON objects received
+over the network, or parsed JSON or YAML files, to check if they satisfy a
+TypeScript interface, and to produce informative error messages if they do not.
+
+## Installation
+
+```bash
+npm install --save-dev ts-interface-builder
+npm install --save ts-interface-checker
+```
+
+## Usage
+
+Suppose you have a TypeScript file defining an interface:
+```typescript
+// foo.ts
+interface Square {
+  size: number;
+  color?: string;
+}
+```
+
+The first step is to generate some code for runtime checks:
+```bash
+`npm bin`/ts-interface-builder foo.ts
+```
+
+It produces a file like this:
+```typescript
+// foo-ti.js
+import * as t from "ts-interface-checker";
+
+export const Square = t.iface([], {
+  "size": "number",
+  "color": t.opt("string"),
+});
+...
+```
+
+Now at runtime, to check if a value satisfies the Square interface:
+```typescript
+import fooTI from "./foo-ti";
+import {createCheckers} from "ts-interface-checker";
+
+const {Square} = createCheckers(fooTI);
+
+Square.check({size: 1});                  // OK
+Square.check({size: 1, color: "green"});  // OK
+Square.check({color: "green"});           // Fails with "value.size is missing"
+Square.check({size: 4, color: 5});        // Fails with "value.color is not a string"
+```
+
+Note that `ts-interface-builder` is only needed for the build-time step, and
+`ts-interface-checker` is needed at runtime. That's why the recommendation is to npm-install the
+former using `--save-dev` flag and the latter using `--save`.
+
+## Checking method calls
+
+If you have an interface with methods, you can validate method call arguments and return values:
+```typescript
+// greet.ts
+interface Greeter {
+  greet(name: string): string;
+}
+```
+
+After generating the runtime code, you can now check calls like:
+```typescript
+import greetTI from "./greet-ti";
+import {createCheckers} from "ts-interface-checker";
+
+const {Greeter} = createCheckers(greetTI);
+
+Greeter.methodArgs("greet").check(["Bob"]);     // OK
+Greeter.methodArgs("greet").check([17]);        // Fails with "value.name is not a string"
+Greeter.methodArgs("greet").check([]);          // Fails with "value.name is missing"
+
+Greeter.methodResult("greet").check("hello");   // OK
+Greeter.methodResult("greet").check(null);      // Fails with "value is not a string"
+```
+
+## Type suites
+
+If one type refers to a type defined in another file, you need to tell the interface checker about
+all type names when you call `createCheckers()`. E.g. given
+
+```typescript
+// color.ts
+export type Color = RGB | string;
+export type RGB = [number, number, number];
+```
+
+```typescript
+// shape.ts
+import {Color} from "./color";
+export interface Square {
+  size: number;
+  color?: Color;
+}
+```
+
+the produced files `color-ti.ts` and `shape-ti.ts` do not automatically refer to each other, but
+expect you to relate them in `createCheckers()` call:
+```typescript
+import color from "./color-ti";
+import shape from "./shape-ti";
+import {createCheckers} from "ts-interface-checker";
+
+const {Square} = createCheckers(shape, color);    // Pass in all required type suites.
+
+Square.check({size: 1, color: [255,255,255]});
+```
+
+## Strict checking
+
+You may check that data contains no extra properties. Note that it is not generally recommended as
+it this prevents backward compatibility: if you add new properties to an interface, then older
+code with strict checks will not accept them.
+
+Following on the example above:
+```typescript
+Square.strictCheck({size: 1, color: [255,255,255], bg: "blue"});    // Fails with value.bg is extraneous
+Square.strictCheck({size: 1, color: [255,255,255,0.5]});            // Fails with ...value.color[3] is extraneous
+```
+
+## Type guards
+
+Standard `Checker` objects do the type checking logic, but are unable to make the TypeScript
+compiler aware that an object of `unknown` type implements a certain interface.
+
+Basic code:
+```typescript
+const unk: unknown = {size: 1, color: "green"};
+// Type is unknown, so TypeScript will not let you access the members.
+console.log(unk.size); // Error: "Object is of type 'unknown'"
+```
+
+With a `Checker` available:
+```typescript
+import fooTI from "./foo-ti";
+import {createCheckers} from "ts-interface-checker";
+
+const {Square} = createCheckers(fooTI);
+
+const unk: unknown = {size: 1, color: "green"};
+
+if (Square.test(unk)) {
+  // unk does implement Square, but TypeScript is not aware of it.
+  console.log(unk.size); // Error: "Object is of type 'unknown'"
+}
+```
+
+To enable type guard functionality on the existing `test`, and `strictTest` functions, `Checker`
+objects should be cast to `CheckerT<>` using the appropriate type.
+
+Using `CheckerT<>`:
+```typescript
+import {Square} from "./foo";
+import fooTI from "./foo-ti";
+import {createCheckers, CheckerT} from "ts-interface-checker";
+
+const {Square} = createCheckers(fooTI) as {Square: CheckerT<Square>};
+
+const unk: unknown = {size: 1, color: "green"};
+
+if (Square.test(unk)) {
+  // TypeScript is now aware that unk implements Square, and allows member access.
+  console.log(unk.size);
+}
+```
+
+## Type assertions
+
+`CheckerT<>` will eventually support type assertions using the `check` and `strictCheck` functions,
+however, this feature is not yet fully working in TypeScript.

package/website/node_modules/ts-interface-checker/dist/index.d.ts

@@ -0,0 +1,124 @@
+import { ITypeSuite, TType } from "./types";
+import { IErrorDetail } from "./util";
+/**
+ * Export functions used to define interfaces.
+ */
+export { TArray, TEnumType, TEnumLiteral, TFunc, TIface, TLiteral, TName, TOptional, TParam, TParamList, TProp, TTuple, TType, TUnion, TIntersection, array, enumlit, enumtype, func, iface, lit, name, opt, param, tuple, union, intersection, BasicType, ITypeSuite, } from "./types";
+export { VError, IErrorDetail } from './util';
+export interface ICheckerSuite {
+    [name: string]: Checker;
+}
+/**
+ * Takes one of more type suites (e.g. a module generated by `ts-interface-builder`), and combines
+ * them into a suite of interface checkers. If a type is used by name, that name should be present
+ * among the passed-in type suites.
+ *
+ * The returned object maps type names to Checker objects.
+ */
+export declare function createCheckers(...typeSuite: ITypeSuite[]): ICheckerSuite;
+/**
+ * Checker implements validation of objects, and also includes accessors to validate method calls.
+ * Checkers should be created using `createCheckers()`.
+ */
+export declare class Checker {
+    private suite;
+    private ttype;
+    private _path;
+    private props;
+    private checkerPlain;
+    private checkerStrict;
+    constructor(suite: ITypeSuite, ttype: TType, _path?: string);
+    /**
+     * Set the path to report in errors, instead of the default "value". (E.g. if the Checker is for
+     * a "person" interface, set path to "person" to report e.g. "person.name is not a string".)
+     */
+    setReportedPath(path: string): void;
+    /**
+     * Check that the given value satisfies this checker's type, or throw Error.
+     */
+    check(value: any): void;
+    /**
+     * A fast check for whether or not the given value satisfies this Checker's type. This returns
+     * true or false, does not produce an error message, and is fast both on success and on failure.
+     */
+    test(value: any): boolean;
+    /**
+     * Returns an error object describing the errors if the given value does not satisfy this
+     * Checker's type, or null if it does.
+     */
+    validate(value: any): IErrorDetail | null;
+    /**
+     * Check that the given value satisfies this checker's type strictly. This checks that objects
+     * and tuples have no extra members. Note that this prevents backward compatibility, so usually
+     * a plain check() is more appropriate.
+     */
+    strictCheck(value: any): void;
+    /**
+     * A fast strict check for whether or not the given value satisfies this Checker's type. Returns
+     * true or false, does not produce an error message, and is fast both on success and on failure.
+     */
+    strictTest(value: any): boolean;
+    /**
+     * Returns an error object describing the errors if the given value does not satisfy this
+     * Checker's type strictly, or null if it does.
+     */
+    strictValidate(value: any): IErrorDetail | null;
+    /**
+     * If this checker is for an interface, returns a Checker for the type required for the given
+     * property of this interface.
+     */
+    getProp(prop: string): Checker;
+    /**
+     * If this checker is for an interface, returns a Checker for the argument-list required to call
+     * the given method of this interface. E.g. if this Checker is for the interface:
+     *    interface Foo {
+     *      find(s: string, pos?: number): number;
+     *    }
+     * Then methodArgs("find").check(...) will succeed for ["foo"] and ["foo", 3], but not for [17].
+     */
+    methodArgs(methodName: string): Checker;
+    /**
+     * If this checker is for an interface, returns a Checker for the return value of the given
+     * method of this interface.
+     */
+    methodResult(methodName: string): Checker;
+    /**
+     * If this checker is for a function, returns a Checker for its argument-list.
+     */
+    getArgs(): Checker;
+    /**
+     * If this checker is for a function, returns a Checker for its result.
+     */
+    getResult(): Checker;
+    /**
+     * Return the type for which this is a checker.
+     */
+    getType(): TType;
+    /**
+     * Actual implementation of check() and strictCheck().
+     */
+    private _doCheck;
+    private _doValidate;
+    private _getMethod;
+}
+/**
+ * Typed checker interface. Adds type guard functionality to a normal `Checker`.
+ *
+ * To use, cast a `Checker` to a `CheckerT<>` using the appropriate type.
+ *
+ * eg.
+ *   import { MyInterface } from './my-interface';
+ *   import MyInterfaceTi from './my-interface-ti';
+ *
+ *   const checkers = createCheckers(MyInterfaceTi) as {
+ *     MyInterface: CheckerT<MyInterface>
+ *   };
+ *
+ * TODO:
+ * - Enable `check()` and `strictCheck()` type assertion definitions once the functionality
+ *   is correctly working in TypeScript. (https://github.com/microsoft/TypeScript/issues/36931)
+ */
+export interface CheckerT<T> extends Checker {
+    test(value: any): value is T;
+    strictTest(value: any): value is T;
+}