@shapio/schema 0.5.2 → 0.5.4

package/dist/index.d.ts

@@ -17,7 +17,7 @@ export declare const createStableId: () => string;
 //#endregion
 //#region src/types/dataTypes.d.ts
 /** Every stored data type. A field's data type is separate from the editor that renders it (brief §2.5). */
-export declare const DATA_TYPES: readonly ["string", "text", "richtext", "number", "integer", "decimal", "biginteger", "boolean", "date", "datetime", "time", "enum", "json", "slug", "email", "url", "uid", "media", "relation", "component", "dynamiczone"];
+export declare const DATA_TYPES: readonly ["string", "text", "code", "richtext", "number", "integer", "decimal", "biginteger", "boolean", "date", "datetime", "time", "enum", "json", "slug", "email", "url", "uid", "media", "relation", "component", "dynamiczone"];
 export type DataType = (typeof DATA_TYPES)[number];
 export declare const isDataType: (value: unknown) => value is DataType;
 /**
@@ -48,6 +48,9 @@ export type JsonObject = {
 //#region src/types/settings.d.ts
 export declare const MEDIA_KINDS: readonly ["image", "video", "audio", "document", "other"];
 export declare const RELATION_CARDINALITIES: readonly ["one", "many"];
+/** Languages a `code` field can hold. The language reaches the API (OpenAPI, GraphQL, generated types). */
+export declare const CODE_LANGUAGES: readonly ["plain", "html", "css", "javascript", "json", "yaml", "markdown"];
+export type CodeLanguage = (typeof CODE_LANGUAGES)[number];
 export declare const EnumValueSchema: Type.TObject<{
   value: Type.TString;
   label: Type.TString;
@@ -62,6 +65,13 @@ export declare const SETTINGS_SCHEMAS: {
     minLength: Type.TOptional<Type.TInteger>;
     maxLength: Type.TOptional<Type.TInteger>;
   }>;
+  code: Type.TObject<{
+    /** JSON only: a value that does not parse is refused. */
+    validate: Type.TOptional<Type.TBoolean>;
+    minLength: Type.TOptional<Type.TInteger>;
+    maxLength: Type.TOptional<Type.TInteger>;
+    language: Type.TOptional<Type.TEnum<["plain", "html", "css", "javascript", "json", "yaml", "markdown"]>>;
+  }>;
   richtext: Type.TObject<{
     formatVersion: Type.TOptional<Type.TInteger>;
     maxLength: Type.TOptional<Type.TInteger>;
@@ -146,7 +156,10 @@ type SettingsSchemas = typeof SETTINGS_SCHEMAS;
 /** Settings as authored (defaults may be missing). */
 export type DataTypeSettingsInput = { [T in DataType]: Static<SettingsSchemas[T]>; };
 /** Settings after normalization: the defaulted keys are always present. */
-export type DataTypeSettings = Omit<DataTypeSettingsInput, 'richtext' | 'enum' | 'media' | 'component'> & {
+export type DataTypeSettings = Omit<DataTypeSettingsInput, 'code' | 'richtext' | 'enum' | 'media' | 'component'> & {
+  code: DataTypeSettingsInput['code'] & {
+    language: CodeLanguage;
+  };
   richtext: DataTypeSettingsInput['richtext'] & {
     formatVersion: number;
   };
@@ -181,7 +194,7 @@ export declare const FieldInputSchema: Type.TObject<{
   label: Type.TString;
   /** Help text shown under the control. */
   description: Type.TOptional<Type.TString>;
-  type: Type.TEnum<["string", "text", "richtext", "number", "integer", "decimal", "biginteger", "boolean", "date", "datetime", "time", "enum", "json", "slug", "email", "url", "uid", "media", "relation", "component", "dynamiczone"]>;
+  type: Type.TEnum<["string", "text", "code", "richtext", "number", "integer", "decimal", "biginteger", "boolean", "date", "datetime", "time", "enum", "json", "slug", "email", "url", "uid", "media", "relation", "component", "dynamiczone"]>;
   required: Type.TOptional<Type.TBoolean>;
   /** Per-locale value. Ignored (must be false) when the model is not localized. */
   localized: Type.TOptional<Type.TBoolean>;
@@ -273,7 +286,7 @@ export declare const ModelDefinitionInputSchema: Type.TObject<{
     label: Type.TString;
     /** Help text shown under the control. */
     description: Type.TOptional<Type.TString>;
-    type: Type.TEnum<["string", "text", "richtext", "number", "integer", "decimal", "biginteger", "boolean", "date", "datetime", "time", "enum", "json", "slug", "email", "url", "uid", "media", "relation", "component", "dynamiczone"]>;
+    type: Type.TEnum<["string", "text", "code", "richtext", "number", "integer", "decimal", "biginteger", "boolean", "date", "datetime", "time", "enum", "json", "slug", "email", "url", "uid", "media", "relation", "component", "dynamiczone"]>;
     required: Type.TOptional<Type.TBoolean>;
     /** Per-locale value. Ignored (must be false) when the model is not localized. */
     localized: Type.TOptional<Type.TBoolean>;
@@ -316,7 +329,7 @@ export declare const ComponentDefinitionInputSchema: Type.TObject<{
     label: Type.TString;
     /** Help text shown under the control. */
     description: Type.TOptional<Type.TString>;
-    type: Type.TEnum<["string", "text", "richtext", "number", "integer", "decimal", "biginteger", "boolean", "date", "datetime", "time", "enum", "json", "slug", "email", "url", "uid", "media", "relation", "component", "dynamiczone"]>;
+    type: Type.TEnum<["string", "text", "code", "richtext", "number", "integer", "decimal", "biginteger", "boolean", "date", "datetime", "time", "enum", "json", "slug", "email", "url", "uid", "media", "relation", "component", "dynamiczone"]>;
     required: Type.TOptional<Type.TBoolean>;
     /** Per-locale value. Ignored (must be false) when the model is not localized. */
     localized: Type.TOptional<Type.TBoolean>;
@@ -379,7 +392,7 @@ export declare const DefinitionInputSchema: Type.TUnion<[Type.TObject<{
     label: Type.TString;
     /** Help text shown under the control. */
     description: Type.TOptional<Type.TString>;
-    type: Type.TEnum<["string", "text", "richtext", "number", "integer", "decimal", "biginteger", "boolean", "date", "datetime", "time", "enum", "json", "slug", "email", "url", "uid", "media", "relation", "component", "dynamiczone"]>;
+    type: Type.TEnum<["string", "text", "code", "richtext", "number", "integer", "decimal", "biginteger", "boolean", "date", "datetime", "time", "enum", "json", "slug", "email", "url", "uid", "media", "relation", "component", "dynamiczone"]>;
     required: Type.TOptional<Type.TBoolean>;
     /** Per-locale value. Ignored (must be false) when the model is not localized. */
     localized: Type.TOptional<Type.TBoolean>;
@@ -421,7 +434,7 @@ export declare const DefinitionInputSchema: Type.TUnion<[Type.TObject<{
     label: Type.TString;
     /** Help text shown under the control. */
     description: Type.TOptional<Type.TString>;
-    type: Type.TEnum<["string", "text", "richtext", "number", "integer", "decimal", "biginteger", "boolean", "date", "datetime", "time", "enum", "json", "slug", "email", "url", "uid", "media", "relation", "component", "dynamiczone"]>;
+    type: Type.TEnum<["string", "text", "code", "richtext", "number", "integer", "decimal", "biginteger", "boolean", "date", "datetime", "time", "enum", "json", "slug", "email", "url", "uid", "media", "relation", "component", "dynamiczone"]>;
     required: Type.TOptional<Type.TBoolean>;
     /** Per-locale value. Ignored (must be false) when the model is not localized. */
     localized: Type.TOptional<Type.TBoolean>;

package/dist/index.js

@@ -8,6 +8,7 @@ import { Value } from "typebox/value";
 const DATA_TYPES = [
 	"string",
 	"text",
+	"code",
 	"richtext",
 	"number",
 	"integer",
@@ -74,6 +75,7 @@ const REFERENCE_DATA_TYPES = /* @__PURE__ */ new Set([
 const STORAGE_FAMILY = {
 	string: "jsonString",
 	text: "jsonString",
+	code: "jsonString",
 	slug: "jsonString",
 	email: "jsonString",
 	url: "jsonString",
@@ -255,6 +257,16 @@ const MEDIA_KINDS = [
 	"other"
 ];
 const RELATION_CARDINALITIES = ["one", "many"];
+/** Languages a `code` field can hold. The language reaches the API (OpenAPI, GraphQL, generated types). */
+const CODE_LANGUAGES = [
+	"plain",
+	"html",
+	"css",
+	"javascript",
+	"json",
+	"yaml",
+	"markdown"
+];
 const EnumValueSchema = Type.Object({
 	value: Type.String({
 		minLength: 1,
@@ -274,6 +286,12 @@ const SETTINGS_SCHEMAS = {
 		}))
 	}, closed$2),
 	text: Type.Object(lengthRules, closed$2),
+	code: Type.Object({
+		language: Type.Optional(Type.Enum(CODE_LANGUAGES)),
+		...lengthRules,
+		/** JSON only: a value that does not parse is refused. */
+		validate: Type.Optional(Type.Boolean())
+	}, closed$2),
 	richtext: Type.Object({
 		formatVersion: Type.Optional(Type.Integer({ minimum: 1 })),
 		maxLength: Type.Optional(Type.Integer({ minimum: 1 }))
@@ -482,6 +500,14 @@ const entries = [
 			maximum: 80
 		})) }, closed$1)
 	},
+	{
+		id: "codeEditor",
+		dataTypes: ["code"],
+		optionsSchema: Type.Object({ rows: Type.Optional(Type.Integer({
+			minimum: 3,
+			maximum: 80
+		})) }, closed$1)
+	},
 	{
 		id: "mediaPicker",
 		dataTypes: ["media"],
@@ -514,6 +540,7 @@ const EDITOR_CATALOGUE = new Map(entries.map((entry) => [entry.id, entry]));
 const DEFAULT_EDITORS = {
 	string: "textInput",
 	text: "textarea",
+	code: "codeEditor",
 	richtext: "richText",
 	number: "numberInput",
 	integer: "numberInput",
@@ -715,6 +742,7 @@ const suggestPlural = (apiKey) => {
 //#endregion
 //#region src/normalize.ts
 const SETTINGS_DEFAULTS = {
+	code: { language: "plain" },
 	richtext: { formatVersion: 1 },
 	enum: { multiple: false },
 	media: { multiple: false },
@@ -823,6 +851,7 @@ const checkDefaultValue = (field) => {
 	switch (field.type) {
 		case "string":
 		case "text":
+		case "code":
 		case "email":
 		case "url": return isString ? null : "must be a string";
 		case "slug": return matches(SLUG_PATTERN) ? null : "must be a lower-case slug";
@@ -1167,6 +1196,7 @@ const checkSettings = (field, path, definition) => {
 		if (!source) issues.push(issue(`${path}/settings/sourceFieldId`, "UNKNOWN_FIELD_REFERENCE", "refers to no field of this definition"));
 		else if (source.type !== "string" && source.type !== "text") issues.push(issue(`${path}/settings/sourceFieldId`, "INVALID_FIELD_REFERENCE", "must refer to a string or text field"));
 	}
+	if (field.type === "code" && field.settings.validate && field.settings.language !== "json") issues.push(issue(`${path}/settings/validate`, "INVALID_SETTINGS", "only a json code field can be validated"));
 	if (field.type === "richtext" && field.settings.formatVersion !== 1) issues.push(issue(`${path}/settings/formatVersion`, "INVALID_SETTINGS", "unsupported rich-text format version"));
 	if (field.type === "relation" && !isStableId(field.settings.target)) issues.push(issue(`${path}/settings/target`, "INVALID_ID", "must be the ID of a model"));
 	if (field.type === "component" && !isStableId(field.settings.component)) issues.push(issue(`${path}/settings/component`, "INVALID_ID", "must be the ID of a component"));
@@ -1813,6 +1843,7 @@ const hasIndex = (field) => Boolean(field && (field.filterable || field.sortable
 const API_SCALAR = {
 	string: "String",
 	text: "String",
+	code: "String",
 	slug: "String",
 	email: "String",
 	url: "String",
@@ -1834,6 +1865,12 @@ const API_SCALAR = {
 	dynamiczone: "DynamicZone"
 };
 const PLAIN_TEXT_TYPES = /* @__PURE__ */ new Set(["string", "text"]);
+/** Types any string value is valid for, so a same-family change to one without constraints only widens. */
+const TEXT_TARGETS = /* @__PURE__ */ new Set([
+	"string",
+	"text",
+	"code"
+]);
 const SCALAR_FAMILIES = /* @__PURE__ */ new Set([
 	"jsonString",
 	"jsonNumber",
@@ -1842,23 +1879,23 @@ const SCALAR_FAMILIES = /* @__PURE__ */ new Set([
 ]);
 const hasTextConstraints = (field) => {
 	const settings = field?.settings ?? {};
-	return settings.minLength !== void 0 || settings.maxLength !== void 0 || settings.pattern !== void 0;
+	return settings.minLength !== void 0 || settings.maxLength !== void 0 || settings.pattern !== void 0 || settings.validate === true;
 };
 /**
 * A type change. Within one storage family the stored JSON stays as it is: widening is live, anything else
 * re-validates existing values. Across families Shapio converts values with a job, for the pairs it knows.
 */
 const classifyTypeChange = (from, to, after) => {
-	const breaking = API_SCALAR[from] !== API_SCALAR[to];
+	const breaking = API_SCALAR[from] !== API_SCALAR[to] || to === "code" && from !== "code";
 	const fromFamily = STORAGE_FAMILY[from];
 	const toFamily = STORAGE_FAMILY[to];
-	if (fromFamily === toFamily) return fromFamily === "jsonString" && PLAIN_TEXT_TYPES.has(to) && !hasTextConstraints(after) || from === "integer" && to === "number" || from === "biginteger" && to === "decimal" && after?.type === "decimal" && after.settings.precision === void 0 ? result("additive", { breaking }) : result("validation", {
+	if (fromFamily === toFamily) return fromFamily === "jsonString" && TEXT_TARGETS.has(to) && !hasTextConstraints(after) || from === "integer" && to === "number" || from === "biginteger" && to === "decimal" && after?.type === "decimal" && after.settings.precision === void 0 ? result("additive", { breaking }) : result("validation", {
 		breaking,
 		prerequisites: ["validateValues"]
 	});
 	const numericPair = fromFamily === "jsonNumber" && toFamily === "numericString" || fromFamily === "numericString" && toFamily === "jsonNumber";
 	const toText = SCALAR_FAMILIES.has(fromFamily) && PLAIN_TEXT_TYPES.has(to);
-	const textToRichtext = fromFamily === "jsonString" && to === "richtext";
+	const textToRichtext = fromFamily === "jsonString" && from !== "code" && to === "richtext";
 	const richtextToText = from === "richtext" && PLAIN_TEXT_TYPES.has(to);
 	const supported = numericPair || toText || textToRichtext || richtextToText;
 	return result("conversion", {
@@ -1905,7 +1942,9 @@ const classifySettingsChange = (change) => {
 		case "components":
 		case "allowedKinds":
 		case "protocols": return validation(to !== void 0 && (from === void 0 || removesAny(from, to)));
-		case "sourceFieldId": return result("metadata");
+		case "sourceFieldId":
+		case "language": return result("metadata");
+		case "validate": return validation(to === true);
 		case "multiple":
 		case "repeatable":
 		case "cardinality": return result("conversion", {
@@ -2633,6 +2672,6 @@ const SeoDefaultsSchema = Type.Object({
 	twitterHandle: Type.Union([Type.String({ pattern: SEO_TWITTER_HANDLE_PATTERN.source }), Type.Null()])
 }, closed);
 //#endregion
-export { API_KEY_PATTERN, BIGINTEGER_PATTERN, BUILT_IN_THEME_KEYS, CANVAS_ELIGIBLE, CHANGE_KINDS, COMPONENT_TYPE_SUFFIXES, CUSTOM_EDITOR_ID_PATTERN, ComponentDefinitionInputSchema, ComponentDisplayInputSchema, DATA_TYPES, DATETIME_PATTERN, DATE_PATTERN, DECIMAL_PATTERN, DEFAULT_EDITORS, DEFAULT_SEO_KEYS, DEFINITION_KINDS, DefinitionInputSchema, EDITOR_CATALOGUE, EMPTY_SEO_DEFAULTS, EditorChoiceInputSchema, EnumValueSchema, FieldInputSchema, INLINE_TITLE_TYPES, LOCALE_CODE_PATTERN, LOCK_FILE_FORMAT_VERSION, LOCK_FILE_PATH, LocaleInputSchema, LockEntrySchema, LockFileError, LockFileSchema, MARK_RULES, MAX_API_KEY_LENGTH, MAX_COMPONENT_DEPTH, MAX_DESCRIPTION_LENGTH, MAX_FALLBACK_CHAIN, MAX_FIELDS_PER_DEFINITION, MAX_LABEL_LENGTH, MAX_RICHTEXT_DEPTH, MEDIA_KINDS, MODEL_KINDS, MODEL_TYPE_SUFFIXES, MUTATION_PREFIXES, ModelDefinitionInputSchema, ModelDisplayInputSchema, NODE_RULES, PLURAL_FALLBACK_SUFFIX, REFERENCE_DATA_TYPES, RELATION_CARDINALITIES, RESERVED_DEFINITION_API_KEYS, RESERVED_FIELD_API_KEYS, RESERVED_QUERY_NAMES, RESERVED_TYPE_NAMES, RICHTEXT_FORMAT, RICHTEXT_FORMAT_VERSION, SAFE_LINK_PATTERN, SCALAR_DATA_TYPES, SCHEMA_KIND_DIRECTORIES, SEO_COMPONENT_API_KEY, SEO_COMPONENT_ID, SEO_DESCRIPTION_SOFT_MAX, SEO_EDITOR_ID, SEO_FIELD_IDS, SEO_TITLE_PLACEHOLDER, SEO_TITLE_SOFT_MAX, SEO_TITLE_TEMPLATE_PATTERN, SEO_TWITTER_HANDLE_PATTERN, SETTINGS_SCHEMAS, SITES_DIRECTORY, SLUG_PATTERN, SORT_DIRECTIONS, STABLE_ID_PATTERN, STORAGE_FAMILY, STRIP_DEFAULT_COUNT, SchemaValidationError, SeoDefaultsSchema, SeoLocaleDefaultsSchema, TEXT_TITLE_FIELD_TYPES, THEME_BRAND_TOKENS, THEME_COLOUR_PATTERN, THEME_DARK_UI_PAIRS, THEME_KEY_PATTERN, THEME_SEMANTIC_TOKENS, THEME_TEXT_PAIRS, THEME_TOKENS, THEME_UI_PAIRS, THEME_VARIANTS, TIME_PATTERN, TITLE_FIELD_TYPES, UID_PATTERN, UNIQUE_CAPABLE_DATA_TYPES, applyTitleTemplate, assignIds, canonicalJson, checkApiKeySyntax, checkDefaultValue, checkThemeContrast, classifyChange, classifyChanges, classifyLocaleChange, collectionQueryName, contrastRatio, createStableId, decideSync, diffDefinitions, effectiveLayout, effectiveTitleField, embeddedComponentIds, escapeHtml, findDependentModels, findReferencingDefinitions, foldApiKey, generatedNames, hashDefinition, isApiKeySyntaxValid, isCanvasEligible, isComponentDefinition, isCoverEligible, isCustomEditorId, isDataType, isDocumentPlaceable, isEmptyRichText, isModelDefinition, isSeoField, isStableId, isValidTitleTemplate, issue, listCompatibleEditors, lockCoversSite, lockEntriesForSite, mergePulledLock, normalizeDefinition, parseDefinition, parseLockFile, plainTextToRichText, renderRichTextHtml, renormalizeDefinition, resolveSeo, richTextMediaIds, richTextToPlainText, routeKeyOf, schemaFilePath, scopeDirectory, scopeOfSchemaFilePath, seoComponentDefinition, seoDefaultsForLocale, serializeDefinition, serializeLockFile, sha256, stripFieldsOf, suggestPlural, summarizeChanges, toTypeName, upgradeLockFile, validateDefinition, validateRichText, validateSchema, withDerivedPlural, withSiteCovered };
+export { API_KEY_PATTERN, BIGINTEGER_PATTERN, BUILT_IN_THEME_KEYS, CANVAS_ELIGIBLE, CHANGE_KINDS, CODE_LANGUAGES, COMPONENT_TYPE_SUFFIXES, CUSTOM_EDITOR_ID_PATTERN, ComponentDefinitionInputSchema, ComponentDisplayInputSchema, DATA_TYPES, DATETIME_PATTERN, DATE_PATTERN, DECIMAL_PATTERN, DEFAULT_EDITORS, DEFAULT_SEO_KEYS, DEFINITION_KINDS, DefinitionInputSchema, EDITOR_CATALOGUE, EMPTY_SEO_DEFAULTS, EditorChoiceInputSchema, EnumValueSchema, FieldInputSchema, INLINE_TITLE_TYPES, LOCALE_CODE_PATTERN, LOCK_FILE_FORMAT_VERSION, LOCK_FILE_PATH, LocaleInputSchema, LockEntrySchema, LockFileError, LockFileSchema, MARK_RULES, MAX_API_KEY_LENGTH, MAX_COMPONENT_DEPTH, MAX_DESCRIPTION_LENGTH, MAX_FALLBACK_CHAIN, MAX_FIELDS_PER_DEFINITION, MAX_LABEL_LENGTH, MAX_RICHTEXT_DEPTH, MEDIA_KINDS, MODEL_KINDS, MODEL_TYPE_SUFFIXES, MUTATION_PREFIXES, ModelDefinitionInputSchema, ModelDisplayInputSchema, NODE_RULES, PLURAL_FALLBACK_SUFFIX, REFERENCE_DATA_TYPES, RELATION_CARDINALITIES, RESERVED_DEFINITION_API_KEYS, RESERVED_FIELD_API_KEYS, RESERVED_QUERY_NAMES, RESERVED_TYPE_NAMES, RICHTEXT_FORMAT, RICHTEXT_FORMAT_VERSION, SAFE_LINK_PATTERN, SCALAR_DATA_TYPES, SCHEMA_KIND_DIRECTORIES, SEO_COMPONENT_API_KEY, SEO_COMPONENT_ID, SEO_DESCRIPTION_SOFT_MAX, SEO_EDITOR_ID, SEO_FIELD_IDS, SEO_TITLE_PLACEHOLDER, SEO_TITLE_SOFT_MAX, SEO_TITLE_TEMPLATE_PATTERN, SEO_TWITTER_HANDLE_PATTERN, SETTINGS_SCHEMAS, SITES_DIRECTORY, SLUG_PATTERN, SORT_DIRECTIONS, STABLE_ID_PATTERN, STORAGE_FAMILY, STRIP_DEFAULT_COUNT, SchemaValidationError, SeoDefaultsSchema, SeoLocaleDefaultsSchema, TEXT_TITLE_FIELD_TYPES, THEME_BRAND_TOKENS, THEME_COLOUR_PATTERN, THEME_DARK_UI_PAIRS, THEME_KEY_PATTERN, THEME_SEMANTIC_TOKENS, THEME_TEXT_PAIRS, THEME_TOKENS, THEME_UI_PAIRS, THEME_VARIANTS, TIME_PATTERN, TITLE_FIELD_TYPES, UID_PATTERN, UNIQUE_CAPABLE_DATA_TYPES, applyTitleTemplate, assignIds, canonicalJson, checkApiKeySyntax, checkDefaultValue, checkThemeContrast, classifyChange, classifyChanges, classifyLocaleChange, collectionQueryName, contrastRatio, createStableId, decideSync, diffDefinitions, effectiveLayout, effectiveTitleField, embeddedComponentIds, escapeHtml, findDependentModels, findReferencingDefinitions, foldApiKey, generatedNames, hashDefinition, isApiKeySyntaxValid, isCanvasEligible, isComponentDefinition, isCoverEligible, isCustomEditorId, isDataType, isDocumentPlaceable, isEmptyRichText, isModelDefinition, isSeoField, isStableId, isValidTitleTemplate, issue, listCompatibleEditors, lockCoversSite, lockEntriesForSite, mergePulledLock, normalizeDefinition, parseDefinition, parseLockFile, plainTextToRichText, renderRichTextHtml, renormalizeDefinition, resolveSeo, richTextMediaIds, richTextToPlainText, routeKeyOf, schemaFilePath, scopeDirectory, scopeOfSchemaFilePath, seoComponentDefinition, seoDefaultsForLocale, serializeDefinition, serializeLockFile, sha256, stripFieldsOf, suggestPlural, summarizeChanges, toTypeName, upgradeLockFile, validateDefinition, validateRichText, validateSchema, withDerivedPlural, withSiteCovered };
 
 //# sourceMappingURL=index.js.map