npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@prom-cms/schema

v0.12.0-main.17ba11b565cff133a05861f58e47fec23633c1d7

Published

Schema package for prom cms packages

Downloads

893

Readme

This is a schema package for prom-cms packages.

Introduction

This package includes all schema, mainly generator config schemas, that PromCMS uses internally. This documentation won't describe every one of them - for this you should look at code, because it's very descriptive by itself since schemas are written with zod

Nonetheless this documentation will describe how you should approach schema and describe field types and their meaning.

Schema

PromCMS schema is split into two basic parts Project and Database.

  • Project - This part describes project basic settings (such as name, slug, url, etc)

  • Database - This part describes database layer of your project

    • Models - Record of all of your models (posts, products, etc) - extended from "Database Item Base"
    • Singletons - Record of all of your singletons (specific pages, contacts, or other non repetitive content) - extended from "Database Item Base"
  • Database Item Base - Base schema for Models and Singletons. Has defined columns and other config that is specific for both Models and Singletons

    • Columns - Union record of multiple column types. Every column type extends "Column Type Base"
      • Normal - Basic column types that does not require specific options

        • type: Enum
          • date
          • password
          • dateTime
          • longText
      • JSON - JSON column type. This field has also multiple types of fields in admin.

        • admin
          • fieldType: Enum
            • repeater
              • With this you have to define your columns in repeater
            • blockEditor - rich editor
            • jsonEditor default - basic textarea with support of json
            • openingHours - opening hours field
      • String - Basic string field. Can also take multiple rendering types in admin.

        • admin
          • fieldType: Enum
            • heading
            • normal
      • Enum - Classic enum field type

      • File - Field for selecting fields from PromCMS file system. This field can also take multiple forms of rendering in admin.

        • admin
          • fieldType: Enum
            • normal default
            • big-image
            • small-image
      • Number - Classic number field

      • Relationship - Relationship field type. With this you can "link" models between each other. This field renders as a select in admin.

      • Slug - Field type that automatically updates itself based on value of specified string field that is slugified

      • Boolean - Classic boolean field. True or False

  • Column Type Base - Options for every column type. Includes options for admin view, translations and more