@luzmo/dashboard-contents-types v1.0.3

Types and JSON schemas for Luzmo dashboard contents

This packages contains different dashboard contents' types and JSON schemas for Luzmo dashboard contents.

Content Item Types

Here is the list of some types for content items. There are more types available in the package.

JSON Schemas

The library also provides JSON schemas for the content items. The schemas are provided as an object with the schema name as the key and the schema as the value.

import { JSON_SCHEMAS } from '@luzmo/dashboard-contents-types';

console.log(JSON_SCHEMAS);
console.log(JSON_SCHEMAS['text-options.schema.json']);

The JSON schemas are not dereferenced. You can use a library like json-schema-ref-parser to dereference the schemas. json-schema-ref-parser is a Node library so to use it in a browser environment you should add a configuration for that.

import * as refParser from '@apidevtools/json-schema-ref-parser';
import { JSON_SCHEMAS } from '@luzmo/dashboard-contents-types';

const refParserResolver = {
  order: 101,
  canRead: /^https:\/\/developer\.luzmo\.com/,
  read: (file, callback) => {
    const name = file.url.split('/').pop();
    const schema = JSON_SCHEMAS[name];

    if (schema) {
      callback(null, JSON.stringify(schema));
    } else {
      callback(new Error('Schema not found'));
    }
  }
};

const refParserOptions = {
  mutateInputSchema: false,
  resolve: {
    http: refParserResolver,
    external: true
  }
};

refParser.dereference(JSON_SCHEMAS['area-chart-slots.schema.json'], refParserOptions)
  .then((dereferencedSchema) => {
    console.log(dereferencedSchema);
  })
  .catch((err) => {
    console.error(err);
  });

To validate a content item against a schema, you can use a library like ajv.

import Ajv from "ajv";
import ajvAddFormats from 'ajv-formats';
import { JSON_SCHEMAS } from '@luzmo/dashboard-contents-types';

const ajv = new Ajv({
  schemas: Object.keys(JSON_SCHEMAS).map(key => JSON_SCHEMAS[key]),
  allowUnionTypes: true,
  strictTuples: false
});

ajvAddFormats(ajv);

const schemaId = 'https://developer.luzmo.com/assets/json-schemas/0.1.89/text-options.schema.json';
const validate = ajv.getSchema(schemaId);
const isValid = validate('VALUE TO VALIDATE');

console.log(isValid);