Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@communities-webruntime/metadata-schema

Package Overview
Dependencies
Maintainers
2
Versions
359
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@communities-webruntime/metadata-schema

UI metadata schema specs for Lightning Web Runtime

  • 1.66.1
  • npm
  • Socket score

Version published
Weekly downloads
337
decreased by-55.77%
Maintainers
2
Weekly downloads
 
Created
Source

UI Metadata Schema

Model the shape of your UI in JSON using a unified schema.

This project is currently only used by @communities-webruntime and its corresponding validators.

Overview

Metadata-schema validates the shape of different types of JSON metadata for a LWR project.

The current supported schemas include:

  • base (canonical metadata)
  • communities (declarative metadata)

The metadata types include:

  • branding
  • routes
  • theme
  • view

Usage

To validate against the schema, import the MetadataValidator:

import MetadataValidator from '@communities-webruntime/metadata-schema';

const schema = 'communities';   // name of the schema to validate against
const metadataType = 'routes';  // name of the metadata type
const data = ...;
new MetadataValidator(schema).validate(data, metadataType);

For an example, see metadata-validation.ts.

Definitions

NameDescription
ViewA view on a screen. Also known as a Page.
ComponentA reusable, composable fragment of UI. This is agnostic to technology, i.e. this could be a LWC component or a reusable HTML element.
RegionA part of the view which may contain one or more Components
BrandingPropertyA piece of data which stores visual information such as color or font. This is typically a key:value pair
RouteA route contains metadata about a URL scheme, or any location specifier
ThemeA theme is a complex type which contains metadata about your application's higher-level visuals
ThemeLayoutA theme layout is just another name for a view

For a more detailed rundown of the metadata pieces, see Anatomy of a Communities LWR Template.

Contributing

  1. Edit only the schema affected by your change. Know that any definition changes can affect all schemas. Ensure you are not breaking someone else by looking at the files in the /config folder and verifying the impact of your schema change.
  2. Further ensure you are not breaking someone else by running all tests.
  3. Add tests for your changes to make sure someone else does not break you.

FAQs

Package last updated on 15 Nov 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc