@cmssy/types

Shared TypeScript type definitions for the Cmssy platform.

Installation

npm install @cmssy/types

Usage

import {
  FieldType,
  LayoutPosition,
  BlockConfig,
  TemplateConfig
} from "@cmssy/types";

// Use in block.config.ts
const config: BlockConfig = {
  name: "My Block",
  category: "content",
  schema: {
    title: {
      type: FieldType.SINGLE_LINE,
      label: "Title",
    },
  },
};

Exports

• Field Types: FieldType, FieldConfig, FieldValidation, ShowWhenCondition
• Layout: LayoutPosition, LayoutOverride
• Modules: WorkspaceModule, FeatureFlag, BlockRequires
• Block Config: BlockConfig, BlockSource, PackageType
• Template Config: TemplateConfig, TemplatePageBlueprint, TemplateLayoutPosition

Development

npm install
npm run build
npm run typecheck

Publishing

npm version patch|minor|major
npm publish