ts-runtime-validation 1.0.1 → 1.0.4

package/README.md

@@ -1,8 +1,8 @@
-# ts-runtime-check
+# ts-runtime-validation
 
 ## Why?
 
-Get bulletproof type validation based off typescript interfaces
+Get bulletproof type validation based off typescript interfaces without any extra work. This package will ingest your existing types and generate the code for you.
 
 ## How?
 
@@ -10,27 +10,27 @@ This is a code generator that is designed to run as a yarn / npm script. By defa
 
 ## Footnote
 
-The helper file assumes you have [ajv-validator](https://github.com/ajv-validator/ajv) peer dependency installed.
+The helper file assumes you have [ajv-validator](https://github.com/ajv-validator/ajv) peer dependency installed. Since this is only a code generation tool this package can be installed as a dev dependency.
 
 ## CLI usage
 
 Ensure your project files containing the schemas you want to validate end with the prefix `.jsonschema.ts`
 
 ```
-Usage: ts-runtime-check [options]
+Usage: ts-runtime-validation [options]
 
 Options:
   --glob        Glob file path of typescript files to generate ts-interface -> json-schema validations - default: *.jsonschema.{ts,tsx}
   --rootPath    RootPath of source - default: ./src
-  --output      Validation schema + typescript interface output directory (relative to root path) - default: ./.ts-runtime-check
+  --output      Validation schema + typescript interface output directory (relative to root path) - default: ./.ts-runtime-validation
   --no-helpers  Only generate JSON schema without typescript helper files
   -h, --help    display help for command
 ```
 
-## Usage with helper function
+## Example usage of generated ts type validation
 
 ```typescript
-import { isValidSchema } from "./.ts-runtime-check/isSchemaValid"; // this is autogenerated by the CLI as a helper file
+import { isValidSchema } from "./.ts-runtime-validation/isSchemaValid"; // this is autogenerated by the CLI as a helper file
 
 if (isValidSchema(data, "#/definitions/ITypeA")) {
     // variable: data in this block will have typings for ITypeA

package/dist/index.js

@@ -5,7 +5,7 @@ const SchemaGenerator_1 = require("./SchemaGenerator");
 const commander_1 = require("commander");
 const defaultGlobPattern = "*.jsonschema.{ts,tsx}";
 const defaultRootPath = "./src";
-const defaultOutputFolder = "./.ts-runtime-check";
+const defaultOutputFolder = "./.ts-runtime-validation";
 commander_1.program.option("--glob", `Glob file path of typescript files to generate ts-interface -> json-schema validations - default: ${defaultGlobPattern}`, defaultGlobPattern);
 commander_1.program.option("--rootPath", `RootPath of source - default: ${defaultRootPath}`, defaultRootPath);
 commander_1.program.option("--output", `Validation schema + typescript interface output directory (relative to root path) - default: ${defaultOutputFolder}`, defaultOutputFolder);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEA,uDAAoD;AACpD,yCAAoC;AAEpC,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;AAEnD,MAAM,eAAe,GAAG,OAAO,CAAC;AAChC,MAAM,mBAAmB,GAAG,qBAAqB,CAAC;AASlD,mBAAO,CAAC,MAAM,CACV,QAAQ,EACR,qGAAqG,kBAAkB,EAAE,EACzH,kBAAkB,CACrB,CAAC;AACF,mBAAO,CAAC,MAAM,CAAC,YAAY,EAAE,iCAAiC,eAAe,EAAE,EAAE,eAAe,CAAC,CAAC;AAClG,mBAAO,CAAC,MAAM,CACV,UAAU,EACV,gGAAgG,mBAAmB,EAAE,EACrH,mBAAmB,CACtB,CAAC;AACF,mBAAO,CAAC,MAAM,CAAC,cAAc,EAAE,2DAA2D,EAAE,IAAI,CAAC,CAAC;AAElG,mBAAO,CAAC,KAAK,EAAE,CAAC;AAEhB,MAAM,OAAO,GAAG,mBAAO,CAAC,IAAI,EAAmB,CAAC;AAEhD,IAAI,iCAAe,CAAC,OAAO,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEA,uDAAoD;AACpD,yCAAoC;AAEpC,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;AAEnD,MAAM,eAAe,GAAG,OAAO,CAAC;AAChC,MAAM,mBAAmB,GAAG,0BAA0B,CAAC;AASvD,mBAAO,CAAC,MAAM,CACV,QAAQ,EACR,qGAAqG,kBAAkB,EAAE,EACzH,kBAAkB,CACrB,CAAC;AACF,mBAAO,CAAC,MAAM,CAAC,YAAY,EAAE,iCAAiC,eAAe,EAAE,EAAE,eAAe,CAAC,CAAC;AAClG,mBAAO,CAAC,MAAM,CACV,UAAU,EACV,gGAAgG,mBAAmB,EAAE,EACrH,mBAAmB,CACtB,CAAC;AACF,mBAAO,CAAC,MAAM,CAAC,cAAc,EAAE,2DAA2D,EAAE,IAAI,CAAC,CAAC;AAElG,mBAAO,CAAC,KAAK,EAAE,CAAC;AAEhB,MAAM,OAAO,GAAG,mBAAO,CAAC,IAAI,EAAmB,CAAC;AAEhD,IAAI,iCAAe,CAAC,OAAO,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ts-runtime-validation",
-    "version": "1.0.1",
+    "version": "1.0.4",
     "author": "Matthew Duong <thegalah@gmail.com>",
     "license": "MIT",
     "dependencies": {
@@ -11,7 +11,7 @@
         "typescript-json-schema": "^0.53.0"
     },
     "bin": {
-        "ts-runtime-check": "dist/index.js"
+        "ts-runtime-validation": "dist/index.js"
     },
     "scripts": {
         "build": "tsc",
@@ -28,12 +28,12 @@
     "main": "index.js",
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/thegalah/ts-runtime-check.git"
+        "url": "git+https://github.com/thegalah/ts-runtime-validation.git"
     },
     "bugs": {
-        "url": "https://github.com/thegalah/ts-runtime-check/issues"
+        "url": "https://github.com/thegalah/ts-runtime-validation/issues"
     },
-    "homepage": "https://github.com/thegalah/ts-runtime-check#readme",
+    "homepage": "https://github.com/thegalah/ts-runtime-validation#readme",
     "peerDependencies": {
         "ajv": "^8.11.0"
     }

package/src/index.ts

@@ -6,7 +6,7 @@ import { program } from "commander";
 const defaultGlobPattern = "*.jsonschema.{ts,tsx}";
 
 const defaultRootPath = "./src";
-const defaultOutputFolder = "./.ts-runtime-check";
+const defaultOutputFolder = "./.ts-runtime-validation";
 
 export interface ICommandOptions {
     readonly glob: string;

package/dist/generateSchema.js

@@ -1,51 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = require("path");
-const TJS = __importStar(require("typescript-json-schema"));
-// optionally pass argument to schema generator
-const settings = {
-    required: true,
-};
-// optionally pass ts compiler options
-const compilerOptions = {
-    strictNullChecks: true,
-};
-// optionally pass a base path
-const basePath = "./my-dir";
-const program = TJS.getProgramFromFiles([(0, path_1.resolve)("my-file.ts")], compilerOptions, basePath);
-// We can either get the schema for one file and one type...
-const schema = TJS.generateSchema(program, "MyType", settings);
-// ... or a generator that lets us incrementally get more schemas
-const generator = TJS.buildGenerator(program, settings);
-// generator can be also reused to speed up generating the schema if usecase allows:
-const schemaWithReusedGenerator = TJS.generateSchema(program, "MyType", settings, [], generator);
-// all symbols
-const symbols = generator.getUserSymbols();
-// Get symbols for different types from generator.
-generator.getSchemaForSymbol("MyType");
-generator.getSchemaForSymbol("AnotherType");
-//# sourceMappingURL=generateSchema.js.map

package/dist/generateSchema.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generateSchema.js","sourceRoot":"","sources":["../src/generateSchema.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,+BAA+B;AAE/B,4DAA8C;AAE9C,+CAA+C;AAC/C,MAAM,QAAQ,GAAoB;IAC9B,QAAQ,EAAE,IAAI;CACjB,CAAC;AAEF,sCAAsC;AACtC,MAAM,eAAe,GAAwB;IACzC,gBAAgB,EAAE,IAAI;CACzB,CAAC;AAEF,8BAA8B;AAC9B,MAAM,QAAQ,GAAG,UAAU,CAAC;AAE5B,MAAM,OAAO,GAAG,GAAG,CAAC,mBAAmB,CAAC,CAAC,IAAA,cAAO,EAAC,YAAY,CAAC,CAAC,EAAE,eAAe,EAAE,QAAQ,CAAC,CAAC;AAE5F,4DAA4D;AAC5D,MAAM,MAAM,GAAG,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAE/D,iEAAiE;AAEjE,MAAM,SAAS,GAAG,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AAExD,oFAAoF;AACpF,MAAM,yBAAyB,GAAG,GAAG,CAAC,cAAc,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC;AAEjG,cAAc;AACd,MAAM,OAAO,GAAG,SAAS,CAAC,cAAc,EAAE,CAAC;AAE3C,kDAAkD;AAClD,SAAS,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AACvC,SAAS,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC"}