@shadsapp/schema

Schema, types, and validation for shads.app theme.json documents.

Install

npm install @shadsapp/schema

Schema

Active schema id: shads-theme/v1

Legacy values are accepted on import:

• shadstyle-theme/v1
• shadstyle-theme-brief/v1

Usage

import {
  THEME_SCHEMA,
  validateThemeDocument,
  parseThemeDocumentInput,
  serializeThemeDocumentJson,
} from "@shadsapp/schema"

const result = validateThemeDocument({
  $schema: THEME_SCHEMA,
  config: { basePreset: "workspace" },
  name: "My theme",
})

if (result.ok) {
  console.log(result.document.name)
}

Validate a file or pasted JSON:

const parsed = parseThemeDocumentInput(fileContents)

JSON Schema

import schema from "@shadsapp/schema/schema.json" with { type: "json" }

Or fetch: https://shads.app/schema/theme.schema.json (when hosted).

Related packages

• @shadsapp/themes — curated starter themes
• @shadsapp/cli — install themes in your project

License

MIT