protocolsio-schemas v0.1.3

protocolsio-schemas

This package is meant to provide a collection of schemas that model all objects available in the Protocols.io v3 api. As well a jsonschema validator object is provided that allows you to validate any instance of a Protocols.io object to check if it is valid according to the schema. All schemas are implemented using JSON-SCHEMA.

View the NPM page here

Index

• Installation
• Quick Start
• Available Imports
• Objects
  • User
  • Image
  • Reagent
  • Comment
  • Small Protocol
  • Protocol
  • Step
  • Step Component
  • Step Component Type
  • Case
• Object Validation
• Development
  • Project Structure
  • Running Tests

Installation

npm install --save protocolsio-schemas

Quick Start

import { ProtocolsIOValidator, User } from 'protocolsio-schemas'
let u = {
  "name": "Vladimir Frolov",
  "affiliation": null,
  "username": "vladimir-frolov10",
  "link": null,
  "image": {
    "source": "https://s3.amazonaws.com/pr-journal/djqbjf6.jpg",
    "placeholder": "https://s3.amazonaws.com/pr-journal/djqbjf6.jpg"
  }
}

console.log(ProtocolsIOValidator.validate(u, User))

Available Imports

Import any object from the protocolsio-schema package using its object name.

import {
  User, Image, Reagent,
  Comment, SmallProtocol, Protocol,
  Step, StepComponent, Case,
  StepComponentType1, StepComponentType3, StepComponentType4,
  StepComponentType6, StepComponentType7, StepComponentType8,
  StepComponentType9, StepComponentType13, StepComponentType15,
  StepComponentType17, StepComponentType18, StepComponentType19,
  StepComponentType20, StepComponentType21, StepComponentType22,
  StepComponentType24, StepComponentType25, StepComponentType26,
} from 'protocolsio-schema'

Objects

Note: Under guidance from the Protocols.IO API developer the following fields are currently the only ones that can be confidently said to never be null: id, title, uri, and created_on. Code your checks around this appropriately.

User

Image

Reagent

Comment

Small Protocol

Protocol

Step

Step Component

Step Component Type

There are LOTS of Step Component Types: Read More Here

Case

Object Validation

To validate an object after constructing it you simply need to import the ProtocolsIOValidator object and the associated object schema. Once you have done that you can get a validation object by running the validate() function of the validator.

Following is an example of constructing and validating a Protocols.io User object.

import { ProtocolsIOValidator, User } from 'protocolsio-schemas'
let u = {
  "name": "Vladimir Frolov",
  "affiliation": null,
  "username": "vladimir-frolov10",
  "link": null,
  "image": {
    "source": "https://s3.amazonaws.com/pr-journal/djqbjf6.jpg",
    "placeholder": "https://s3.amazonaws.com/pr-journal/djqbjf6.jpg"
  }
}

console.log(ProtocolsIOValidator.validate(u, User))

Example Validator Output

ValidatorResult {
  instance:
   { name: 'Vladimir Frolov',
     affiliation: null,
     username: 'vladimir-frolov10',
     link: null,
     image:
      { source: 'https://s3.amazonaws.com/pr-journal/djqbjf6.jpg',
        placeholder: 'https://s3.amazonaws.com/pr-journal/djqbjf6.jpg' } },
  schema:
   { id: '/ProtocolsIO/User',
     title: 'User',
     description: 'A Protocols.io User object. http://apidoc.protocols.io/v3/#user-object',
     type: 'object',
     properties:
      { name: [Object],
        affiliation: [Object],
        username: [Object],
        link: [Object],
        image: [Object] },
     required: [ 'name', 'affiliation', 'username', 'link', 'image' ] },
  propertyPath: 'instance',
  errors: [],
  throwError: undefined,
  disableFormat: false }

The ProtocolsIOValidator is an instance of the Validator class from the json schema package. To learn more about what validate returns and how it works please visit the jsonschema documentation

Development

Project Structure

All of the source code is written in ES6 javascript. You will find all ES6 source code under /src. Within that folder you will find a /test and /schemas folder. Schemas contains a JSON-SCHEMA spec for each object. Tests contains a validation script for each object that runs the validate function on several several test objects.

Building Project

After making changes to any of the code in the /src/ folder simply run the following command in the root folder of the project.

npm run build

Running Tests

In the root folder of the project run the following command to run tests.

npm run test