@skweb/datamodel

Data model definition, validation and display tree utilities for skweb projects.

Installation

npm install @skweb/datamodel

Usage

ESM:

import { ModelSchema } from '@skweb/datamodel'

CJS:

const { ModelSchema } = require('@skweb/datamodel')

import { ModelSchema } from '@skweb/datamodel'

const schema = new ModelSchema([
  {
    name: 'someObj',
    label: '',
    type: 'object',
    typeInfo: {},
    desc: '',
    required: true,
    id: 'r8r6ac4gdkg0'
  },
  {
    parentId: 'r8r6ac4gdkg0',
    name: 'aString',
    label: '',
    type: 'string',
    typeInfo: {},
    defV: '',
    desc: '',
    required: false,
    id: '11utlqk9jqig0'
  },
  {
    name: 'c',
    label: '',
    type: 'array',
    typeInfo: {},
    desc: '',
    required: true,
    id: '13fma5urtn1g0'
  }
])

// Get display tree for frontend
const displayList = schema.getDisplayList()
const value = displayList.retrieveValue()

// Validate a value object
schema.validateValue(value)

// Retrieve default values
const defaults = schema.retrieveDefaultValue()

License

MIT