@paroicms/connector/typeonly/common-schema-json-types.d.ts

An API to help build management tools for ParoiCMS instances

import type { JtFieldType, JtLabelLocales } from "./site-schema-json-types.d.ts";

/**
 * The common schema is currently an internal file. Here is its typing.
 */
export interface JtInternalCommonSchema {
  /**
   * This is the version of the schema engine.
   */
  ParoiCMSSiteSchemaFormatVersion: string;
  /**
   * Specify the list of 2-letters language codes that can be used in the websites.
   *
   * @example ["en", "fr"]`
   */
  languages: string[];
  /**
   * The common fields of any websites. They are currently: `["title", "contactEmail", "favicon", "ogImage"]`.
   */
  siteFields: JtFieldType[];
}

export interface JtInternalCommonSchemaTranslations {
  languageLabel: string;
  siteFields?: { [fieldName: string]: JtLabelLocales };
}