aboutsummaryrefslogtreecommitdiffstats
path: root/packages/json-schemas
diff options
context:
space:
mode:
Diffstat (limited to 'packages/json-schemas')
-rw-r--r--packages/json-schemas/README.md17
-rw-r--r--packages/json-schemas/package.json16
-rw-r--r--packages/json-schemas/src/monorepo_scripts/stage_docs.ts8
-rw-r--r--packages/json-schemas/src/schema_validator.ts24
4 files changed, 55 insertions, 10 deletions
diff --git a/packages/json-schemas/README.md b/packages/json-schemas/README.md
index 754ce4e95..f320196e9 100644
--- a/packages/json-schemas/README.md
+++ b/packages/json-schemas/README.md
@@ -2,25 +2,24 @@
Contains 0x-related json schemas
+### Read the [Documentation](0xproject.com/docs/json-schemas).
+
## Installation
```bash
yarn add @0xproject/json-schemas
```
-## Usage
+**Import**
```javascript
-import {SchemaValidator, ValidatorResult, schemas} from '@0xproject/json-schemas';
+import { schemas } from '@0xproject/json-schemas';
+```
-const {orderSchema} = schemas;
-const validator = new SchemaValidator();
+or
-const order = {
- ...
-};
-const validatorResult: ValidatorResult = validator.validate(order, orderSchema); // Contains all errors
-const isValid: boolean = validator.isValid(order, orderSchema); // Only returns boolean
+```javascript
+var schemas = require('@0xproject/json-schemas').schemas;
```
## Contributing
diff --git a/packages/json-schemas/package.json b/packages/json-schemas/package.json
index 1df34a4ef..1266f964b 100644
--- a/packages/json-schemas/package.json
+++ b/packages/json-schemas/package.json
@@ -13,7 +13,20 @@
"test:circleci": "yarn test:coverage",
"run_mocha": "mocha lib/test/**/*_test.js",
"clean": "shx rm -rf lib test_temp scripts",
- "build": "tsc && copyfiles -u 3 './lib/src/monorepo_scripts/**/*' ./scripts"
+ "build": "tsc && copyfiles -u 3 './lib/src/monorepo_scripts/**/*' ./scripts",
+ "docs:stage": "yarn build && node ./scripts/stage_docs.js",
+ "docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --json $JSON_FILE_PATH $PROJECT_FILES",
+ "upload_docs_json": "aws s3 cp generated_docs/index.json $S3_URL --profile 0xproject --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --content-type application/json"
+ },
+ "config": {
+ "postpublish": {
+ "assets": [],
+ "docPublishConfigs": {
+ "extraFileIncludes": ["../types/src/index.ts"],
+ "s3BucketPath": "s3://doc-jsons/json-schemas/",
+ "s3StagingBucketPath": "s3://staging-doc-jsons/json-schemas/"
+ }
+ }
},
"repository": {
"type": "git",
@@ -46,6 +59,7 @@
"nyc": "^11.0.1",
"shx": "^0.2.2",
"tslint": "5.8.0",
+ "typedoc": "0xProject/typedoc",
"typescript": "2.7.1"
},
"publishConfig": {
diff --git a/packages/json-schemas/src/monorepo_scripts/stage_docs.ts b/packages/json-schemas/src/monorepo_scripts/stage_docs.ts
new file mode 100644
index 000000000..e732ac8eb
--- /dev/null
+++ b/packages/json-schemas/src/monorepo_scripts/stage_docs.ts
@@ -0,0 +1,8 @@
+import { postpublishUtils } from '@0xproject/monorepo-scripts';
+
+import * as packageJSON from '../package.json';
+import * as tsConfigJSON from '../tsconfig.json';
+
+const cwd = `${__dirname}/..`;
+// tslint:disable-next-line:no-floating-promises
+postpublishUtils.publishDocsToStagingAsync(packageJSON, tsConfigJSON, cwd);
diff --git a/packages/json-schemas/src/schema_validator.ts b/packages/json-schemas/src/schema_validator.ts
index e13326d2a..38ae766e6 100644
--- a/packages/json-schemas/src/schema_validator.ts
+++ b/packages/json-schemas/src/schema_validator.ts
@@ -3,14 +3,26 @@ import values = require('lodash.values');
import { schemas } from './schemas';
+/**
+ * A validator for [JSON-schemas](http://json-schema.org/)
+ */
export class SchemaValidator {
private _validator: Validator;
+ /**
+ * Instantiates a SchemaValidator instance
+ */
constructor() {
this._validator = new Validator();
for (const schema of values(schemas)) {
this._validator.addSchema(schema, schema.id);
}
}
+ /**
+ * Add a schema to the validator. All schemas and sub-schemas must be added to
+ * the validator before the `validate` and `isValid` methods can be called with
+ * instances of that schema.
+ * @param schema The schema to add
+ */
public addSchema(schema: Schema) {
this._validator.addSchema(schema, schema.id);
}
@@ -18,10 +30,22 @@ export class SchemaValidator {
// sub-types (e.g BigNumber) with a simpler string representation. Since BigNumber and other
// complex types implement the `toString` method, we can stringify the object and
// then parse it. The resultant object can then be checked using jsonschema.
+ /**
+ * Validate the JS object conforms to a specific JSON schema
+ * @param instance JS object in question
+ * @param schema Schema to check against
+ * @returns The results of the validation
+ */
public validate(instance: any, schema: Schema): ValidatorResult {
const jsonSchemaCompatibleObject = JSON.parse(JSON.stringify(instance));
return this._validator.validate(jsonSchemaCompatibleObject, schema);
}
+ /**
+ * Check whether an instance properly adheres to a JSON schema
+ * @param instance JS object in question
+ * @param schema Schema to check against
+ * @returns Whether or not the instance adheres to the schema
+ */
public isValid(instance: any, schema: Schema): boolean {
const isValid = this.validate(instance, schema).errors.length === 0;
return isValid;