@cloudcannon/configuration-types 0.0.8 → 0.0.9

package/build/cloudcannon-config.json

@@ -157,6 +157,16 @@
       },
       "type": "object"
     },
+    "AttributeListPosition": {
+      "enum": [
+        "none",
+        "right",
+        "space right",
+        "below",
+        "newline below"
+      ],
+      "type": "string"
+    },
     "BaseInput": {
       "additionalProperties": false,
       "properties": {
@@ -308,12 +318,6 @@
           "markdownDescription": "Enables a control to copy formatting from text to other text. Only applies to formatting from\n`bold`, `italic`, `underline`, `strike`, `subscript`, and `superscript`. Does not copy other\nstyles or formatting.",
           "type": "boolean"
         },
-        "correct_orientation": {
-          "default": true,
-          "description": "Controls whether or not the JPEG headers defining how an image should be rotated before being displayed is baked into images prior to upload.",
-          "markdownDescription": "Controls whether or not the JPEG headers defining how an image should be rotated before being\ndisplayed is baked into images prior to upload.",
-          "type": "boolean"
-        },
         "embed": {
           "description": "Enables a control to insert a region of raw HTML, including YouTube, Vimeo, Tweets, and other media. Embedded content is sanitized to mitigate XSS risks, which includes removing style tags. Embeds containing script tags are not loaded in the editor.",
           "markdownDescription": "Enables a control to insert a region of raw HTML, including YouTube, Vimeo, Tweets, and other\nmedia. Embedded content is sanitized to mitigate XSS risks, which includes removing style tags.\nEmbeds containing script tags are not loaded in the editor.",
@@ -380,7 +384,8 @@
           "description": "Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.",
           "enum": [
             "image/jpeg",
-            "image/png"
+            "image/png",
+            "image/webp"
           ],
           "markdownDescription": "Sets the format images are converted to prior to upload. The extension of the file is updated\nto match. Defaults to keeping the mime type of the uploaded file.",
           "type": "string"
@@ -1256,61 +1261,10 @@
           "markdownDescription": "Provides scope to configure at a file level, without adding configuration to files.",
           "type": "object"
         },
-        "generator": {
-          "additionalProperties": false,
+        "markdown": {
+          "$ref": "#/definitions/MarkdownSettings",
           "description": "Contains settings for various Markdown engines.",
-          "markdownDescription": "Contains settings for various Markdown engines.",
-          "properties": {
-            "metadata": {
-              "additionalProperties": false,
-              "description": "Settings for various Markdown engines.",
-              "markdownDescription": "Settings for various Markdown engines.",
-              "properties": {
-                "commonmark": {
-                  "description": "Markdown options specific used when markdown is set to \"commonmark\".",
-                  "markdownDescription": "Markdown options specific used when markdown is set to \"commonmark\".",
-                  "type": "object"
-                },
-                "commonmarkghpages": {
-                  "description": "Markdown options specific used when markdown is set to \"commonmarkghpages\".",
-                  "markdownDescription": "Markdown options specific used when markdown is set to \"commonmarkghpages\".",
-                  "type": "object"
-                },
-                "goldmark": {
-                  "description": "Markdown options specific used when markdown is set to \"goldmark\".",
-                  "markdownDescription": "Markdown options specific used when markdown is set to \"goldmark\".",
-                  "type": "object"
-                },
-                "kramdown": {
-                  "description": "Markdown options specific used when markdown is set to \"kramdown\".",
-                  "markdownDescription": "Markdown options specific used when markdown is set to \"kramdown\".",
-                  "type": "object"
-                },
-                "markdown": {
-                  "description": "The Markdown engine used on your site.",
-                  "enum": [
-                    "kramdown",
-                    "commonmark",
-                    "commonmarkghpages",
-                    "goldmark",
-                    "markdown-it"
-                  ],
-                  "markdownDescription": "The Markdown engine used on your site.",
-                  "type": "string"
-                },
-                "markdown-it": {
-                  "description": "Markdown options specific used when markdown is set to \"markdown-it\".",
-                  "markdownDescription": "Markdown options specific used when markdown is set to \"markdown-it\".",
-                  "type": "object"
-                }
-              },
-              "required": [
-                "markdown"
-              ],
-              "type": "object"
-            }
-          },
-          "type": "object"
+          "markdownDescription": "Contains settings for various Markdown engines."
         },
         "paths": {
           "$ref": "#/definitions/Paths",
@@ -3970,12 +3924,6 @@
           "markdownDescription": "If you have one or more DAMs connected to your site, you can use this key to list which asset\nsources can be uploaded to and selected from.",
           "type": "array"
         },
-        "correct_orientation": {
-          "default": true,
-          "description": "Controls whether or not the JPEG headers defining how an image should be rotated before being displayed is baked into images prior to upload.",
-          "markdownDescription": "Controls whether or not the JPEG headers defining how an image should be rotated before being\ndisplayed is baked into images prior to upload.",
-          "type": "boolean"
-        },
         "expandable": {
           "default": false,
           "description": "Controls whether or not images can be upscaled to fit the bounding box during resize prior to upload. Has no effect if files are not resized.",
@@ -3997,7 +3945,8 @@
           "description": "Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.",
           "enum": [
             "image/jpeg",
-            "image/png"
+            "image/png",
+            "image/webp"
           ],
           "markdownDescription": "Sets the format images are converted to prior to upload. The extension of the file is updated\nto match. Defaults to keeping the mime type of the uploaded file.",
           "type": "string"
@@ -4165,12 +4114,6 @@
           "markdownDescription": "If you have one or more DAMs connected to your site, you can use this key to list which asset\nsources can be uploaded to and selected from.",
           "type": "array"
         },
-        "correct_orientation": {
-          "default": true,
-          "description": "Controls whether or not the JPEG headers defining how an image should be rotated before being displayed is baked into images prior to upload.",
-          "markdownDescription": "Controls whether or not the JPEG headers defining how an image should be rotated before being\ndisplayed is baked into images prior to upload.",
-          "type": "boolean"
-        },
         "empty_type": {
           "$ref": "#/definitions/EmptyTypeText",
           "description": "Set how an ‘empty’ value will be saved. Does not apply to existing empty values.",
@@ -4197,7 +4140,8 @@
           "description": "Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.",
           "enum": [
             "image/jpeg",
-            "image/png"
+            "image/png",
+            "image/webp"
           ],
           "markdownDescription": "Sets the format images are converted to prior to upload. The extension of the file is updated\nto match. Defaults to keeping the mime type of the uploaded file.",
           "type": "string"
@@ -4368,6 +4312,164 @@
       },
       "type": "object"
     },
+    "MarkdownAttributeElementOptions": {
+      "additionalProperties": false,
+      "properties": {
+        "block": {
+          "$ref": "#/definitions/AttributeListPosition"
+        },
+        "blockquote": {
+          "$ref": "#/definitions/AttributeListPosition"
+        },
+        "img": {
+          "$ref": "#/definitions/AttributeListPosition"
+        },
+        "inline": {
+          "$ref": "#/definitions/AttributeListPosition"
+        },
+        "li": {
+          "$ref": "#/definitions/AttributeListPosition"
+        },
+        "ol": {
+          "$ref": "#/definitions/AttributeListPosition"
+        },
+        "table": {
+          "$ref": "#/definitions/AttributeListPosition"
+        },
+        "td": {
+          "$ref": "#/definitions/AttributeListPosition"
+        },
+        "tr": {
+          "$ref": "#/definitions/AttributeListPosition"
+        },
+        "ul": {
+          "$ref": "#/definitions/AttributeListPosition"
+        }
+      },
+      "type": "object"
+    },
+    "MarkdownSettings": {
+      "additionalProperties": false,
+      "properties": {
+        "engine": {
+          "enum": [
+            "commonmark",
+            "kramdown"
+          ],
+          "type": "string"
+        },
+        "options": {
+          "additionalProperties": false,
+          "properties": {
+            "attribute_elements": {
+              "$ref": "#/definitions/MarkdownAttributeElementOptions",
+              "description": "Define positioning behaviour of Markdown attributes for different elements.",
+              "markdownDescription": "Define positioning behaviour of Markdown attributes for different elements."
+            },
+            "attributes": {
+              "description": "Save element attributes in Markdown format instead of converting to HTML.",
+              "markdownDescription": "Save element attributes in Markdown format instead of converting to HTML.",
+              "type": "boolean"
+            },
+            "breaks": {
+              "description": "Convert '\\n' in paragraphs into <br>.",
+              "markdownDescription": "Convert '\\n' in paragraphs into <br>.",
+              "type": "boolean"
+            },
+            "code_block_fences": {
+              "description": "Determines which style of code block fences to use.",
+              "enum": [
+                "```",
+                "~~~"
+              ],
+              "markdownDescription": "Determines which style of code block fences to use.",
+              "type": "string"
+            },
+            "escape_snippets_in_code_blocks": {
+              "description": "Render snippets as plain text within code blocks.",
+              "markdownDescription": "Render snippets as plain text within code blocks.",
+              "type": "boolean"
+            },
+            "gfm": {
+              "description": "Enable GFM mode.",
+              "markdownDescription": "Enable GFM mode.",
+              "type": "boolean"
+            },
+            "heading_ids": {
+              "description": "Generate IDs for headings",
+              "markdownDescription": "Generate IDs for headings",
+              "type": "boolean"
+            },
+            "html": {
+              "description": "Output HTML tags from source.",
+              "markdownDescription": "Output HTML tags from source.",
+              "type": "boolean"
+            },
+            "linkify": {
+              "description": "Autoconvert URL-like text to links.",
+              "markdownDescription": "Autoconvert URL-like text to links.",
+              "type": "boolean"
+            },
+            "quotes": {
+              "description": "Double + single quotes replacement pairs, when typographer enabled and smartquotes on. For example, you can use '«»„“' for Russian, '„“‚‘' for German, and ['«\\xA0', '\\xA0»', '‹\\xA0', '\\xA0›'] for French (including nbsp).",
+              "markdownDescription": "Double + single quotes replacement pairs, when typographer enabled and smartquotes on. For example, you can use '«»„“' for Russian, '„“‚‘' for German, and ['«\\xA0', '\\xA0»', '‹\\xA0', '\\xA0›'] for French (including nbsp).",
+              "type": "string"
+            },
+            "sentence_per_line": {
+              "description": "Add linebreaks between sentences in Markdown.",
+              "markdownDescription": "Add linebreaks between sentences in Markdown.",
+              "type": "boolean"
+            },
+            "spaced_lists": {
+              "description": "Output lists with an extra space in Markdown.",
+              "markdownDescription": "Output lists with an extra space in Markdown.",
+              "type": "boolean"
+            },
+            "strikethrough": {
+              "description": "Output strikes in wrapped in double tildes (e.g. ~~strike~~)",
+              "markdownDescription": "Output strikes in wrapped in double tildes (e.g. ~~strike~~)",
+              "type": "boolean"
+            },
+            "subscript": {
+              "description": "Output subscript in wrapped in tildes (e.g. ~sub~)",
+              "markdownDescription": "Output subscript in wrapped in tildes (e.g. ~sub~)",
+              "type": "boolean"
+            },
+            "superscript": {
+              "description": "Output superscript in wrapped in carets (e.g. ^super^)",
+              "markdownDescription": "Output superscript in wrapped in carets (e.g. ^super^)",
+              "type": "boolean"
+            },
+            "table": {
+              "description": "Output tables in Markdown format.",
+              "markdownDescription": "Output tables in Markdown format.",
+              "type": "boolean"
+            },
+            "treat_indentation_as_code": {
+              "description": "Determines whether 4 spaces on indentation should be read as a code block.",
+              "markdownDescription": "Determines whether 4 spaces on indentation should be read as a code block.",
+              "type": "boolean"
+            },
+            "typographer": {
+              "description": "Enable some language-neutral replacement + quotes beautification.",
+              "markdownDescription": "Enable some language-neutral replacement + quotes beautification.",
+              "type": "boolean"
+            },
+            "xhtml": {
+              "description": "Use '/' to close single tags (<br />).",
+              "markdownDescription": "Use '/' to close single tags (<br />).",
+              "type": "boolean"
+            }
+          },
+          "type": "object"
+        }
+      },
+      "required": [
+        "engine",
+        "options"
+      ],
+      "type": "object"
+    },
     "MimeType": {
       "enum": [
         "x-world/x-3dmf",
@@ -5877,12 +5979,6 @@
           "markdownDescription": "Enables a control to copy formatting from text to other text. Only applies to formatting from\n`bold`, `italic`, `underline`, `strike`, `subscript`, and `superscript`. Does not copy other\nstyles or formatting.",
           "type": "boolean"
         },
-        "correct_orientation": {
-          "default": true,
-          "description": "Controls whether or not the JPEG headers defining how an image should be rotated before being displayed is baked into images prior to upload.",
-          "markdownDescription": "Controls whether or not the JPEG headers defining how an image should be rotated before being\ndisplayed is baked into images prior to upload.",
-          "type": "boolean"
-        },
         "embed": {
           "description": "Enables a control to insert a region of raw HTML, including YouTube, Vimeo, Tweets, and other media. Embedded content is sanitized to mitigate XSS risks, which includes removing style tags. Embeds containing script tags are not loaded in the editor.",
           "markdownDescription": "Enables a control to insert a region of raw HTML, including YouTube, Vimeo, Tweets, and other\nmedia. Embedded content is sanitized to mitigate XSS risks, which includes removing style tags.\nEmbeds containing script tags are not loaded in the editor.",
@@ -5959,7 +6055,8 @@
           "description": "Sets the format images are converted to prior to upload. The extension of the file is updated to match. Defaults to keeping the mime type of the uploaded file.",
           "enum": [
             "image/jpeg",
-            "image/png"
+            "image/png",
+            "image/webp"
           ],
           "markdownDescription": "Sets the format images are converted to prior to upload. The extension of the file is updated\nto match. Defaults to keeping the mime type of the uploaded file.",
           "type": "string"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudcannon/configuration-types",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "Contains TypeScript declarations and generates JSONSchema files for the CloudCannon configuration file.",
   "author": "CloudCannon <support@cloudcannon.com>",
   "license": "MIT",

package/src/configuration.d.ts

@@ -9,6 +9,103 @@ import type { Syntax } from './syntax';
 export type InstanceValue = 'UUID' | 'NOW';
 export type EditorKey = 'visual' | 'content' | 'data';
 export type SortOrder = 'ascending' | 'descending' | 'asc' | 'desc';
+export type AttributeListPosition = 'none' | 'right' | 'space right' | 'below' | 'newline below';
+
+export interface MarkdownAttributeElementOptions {
+	inline?: AttributeListPosition;
+	block?: AttributeListPosition;
+	ul?: AttributeListPosition;
+	ol?: AttributeListPosition;
+	li?: AttributeListPosition;
+	table?: AttributeListPosition;
+	tr?: AttributeListPosition;
+	td?: AttributeListPosition;
+	blockquote?: AttributeListPosition;
+	img?: AttributeListPosition;
+
+}
+
+export interface MarkdownSettings {
+	engine: 'commonmark' | 'kramdown';
+	options: {
+		/**
+		 * Output HTML tags from source.
+		 */
+		html?: boolean;
+		/**
+		 * Use '/' to close single tags (<br />).
+		 */
+		xhtml?: boolean;
+		/**
+		 * Convert '\n' in paragraphs into <br>.
+		 */
+		breaks?: boolean;
+		/**
+		 * Autoconvert URL-like text to links.
+		 */
+		linkify?: boolean;
+		/**
+		 * Enable some language-neutral replacement + quotes beautification.
+		 */
+		typographer?: boolean;
+		/**
+		 * Double + single quotes replacement pairs, when typographer enabled and smartquotes on. For example, you can use '«»„“' for Russian, '„“‚‘' for German, and ['«\xA0', '\xA0»', '‹\xA0', '\xA0›'] for French (including nbsp).
+		 */
+		quotes?: string;
+		/**
+		 * Output lists with an extra space in Markdown.
+		 */
+		spaced_lists?: boolean;
+		/**
+		 * Add linebreaks between sentences in Markdown.
+		 */
+		sentence_per_line?: boolean;
+		/**
+		 * Enable GFM mode.
+		 */
+		gfm?: boolean;
+		/**
+		 * Determines which style of code block fences to use.
+		 */
+		code_block_fences?: '```' | '~~~';
+		/**
+		 * Determines whether 4 spaces on indentation should be read as a code block.
+		 */
+		treat_indentation_as_code?: boolean;
+		/**
+		 * Render snippets as plain text within code blocks.
+		 */
+		escape_snippets_in_code_blocks?: boolean;
+		/**
+		 * Output tables in Markdown format.
+		 */
+		table?: boolean;
+		/**
+		 * Output strikes in wrapped in double tildes (e.g. ~~strike~~)
+		 */
+		strikethrough?: boolean;
+		/**
+		 * Output subscript in wrapped in tildes (e.g. ~sub~)
+		 */
+		subscript?: boolean;
+		/**
+		 * Output superscript in wrapped in carets (e.g. ^super^)
+		 */
+		superscript?: boolean;
+		/**
+		 * Generate IDs for headings
+		 */
+		heading_ids?: boolean;
+		/**
+		 * Save element attributes in Markdown format instead of converting to HTML.
+		 */
+		attributes?: boolean;
+		/** 
+		 * Define positioning behaviour of Markdown attributes for different elements.
+		 */ 
+		attribute_elements?: MarkdownAttributeElementOptions;
+	}
+}
 
 // TODO: use SnippetConfig from @cloudcannon/scrap-booker when ParserConfig issue resolved.
 export interface SnippetConfig extends ReducedCascade, Previewable, PickerPreviewable {
@@ -121,14 +218,7 @@ interface ImageResizeable {
 	 * Sets the format images are converted to prior to upload. The extension of the file is updated
 	 * to match. Defaults to keeping the mime type of the uploaded file.
 	 */
-	mime_type?: 'image/jpeg' | 'image/png';
-	/**
-	 * Controls whether or not the JPEG headers defining how an image should be rotated before being
-	 * displayed is baked into images prior to upload.
-	 *
-	 * @default true
-	 */
-	correct_orientation?: boolean;
+	mime_type?: 'image/jpeg' | 'image/png' | 'image/webp';
 	/**
 	 * Sets how uploaded image files are resized with a bounding box defined by width and height prior
 	 * to upload. Has no effect when selecting existing images, or if width and height are unset.
@@ -1493,37 +1583,7 @@ export interface Configuration extends Cascade, WithSnippets {
 	/**
 	 * Contains settings for various Markdown engines.
 	 */
-	generator?: {
-		/**
-		 * Settings for various Markdown engines.
-		 */
-		metadata?: {
-			/**
-			 * The Markdown engine used on your site.
-			 */
-			markdown: 'kramdown' | 'commonmark' | 'commonmarkghpages' | 'goldmark' | 'markdown-it';
-			/**
-			 * Markdown options specific used when markdown is set to "kramdown".
-			 */
-			kramdown?: Record<string, any>;
-			/**
-			 * Markdown options specific used when markdown is set to "commonmark".
-			 */
-			commonmark?: Record<string, any>;
-			/**
-			 * Markdown options specific used when markdown is set to "commonmarkghpages".
-			 */
-			commonmarkghpages?: Record<string, any>;
-			/**
-			 * Markdown options specific used when markdown is set to "goldmark".
-			 */
-			goldmark?: Record<string, any>;
-			/**
-			 * Markdown options specific used when markdown is set to "markdown-it".
-			 */
-			'markdown-it'?: Record<string, any>;
-		};
-	};
+	markdown?: MarkdownSettings;
 	/**
 	 * Specifies the time zone that dates are displayed and edited in. Also changes the suffix the
 	 * date is persisted to the file with.