@cloudcannon/configuration-types 0.0.49 → 0.0.51

package/dist/cloudcannon-config.documentation.schema.json

@@ -10573,12 +10573,99 @@
     "type._snippets_definitions": {
       "id": "type._snippets_definitions",
       "title": "Snippets Definitions",
-      "description": "Extended option used when creating more complex custom snippets.",
+      "description": "A record of reusable values that can be referenced in snippet templates. Values are substituted using { ref: \"key\" } for direct replacement or { spread_ref: \"key\" } for spreading arrays/objects.",
       "type": "object",
       "propertyNames": {
         "type": "string"
       },
-      "additionalProperties": {}
+      "additionalProperties": {
+        "$ref": "#/$defs/type.snippet-definition-value"
+      }
+    },
+    "type.snippet-definition-value": {
+      "id": "type.snippet-definition-value",
+      "title": "Snippet Definition Value",
+      "description": "A reusable value that can be referenced in snippet templates via { ref: \"key\" } or { spread_ref: \"key\" }.",
+      "anyOf": [
+        {
+          "$ref": "#/$defs/type.snippet-format"
+        },
+        {
+          "$ref": "#/$defs/type.snippet-model"
+        },
+        {
+          "title": "Parser Model Array",
+          "description": "An array of model configurations, typically used for positional_args or named_args.",
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/type.snippet-model"
+          }
+        },
+        {
+          "title": "Select Values Array",
+          "description": "An array of select options, typically used for language lists.",
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/type.snippet-definition-select-value"
+          }
+        },
+        {
+          "title": "String Value",
+          "description": "A string value, commonly used for shortcode_name, tag_name, content_key, and similar definitions.",
+          "type": "string"
+        },
+        {
+          "title": "Number Value",
+          "description": "A numeric value.",
+          "type": "number"
+        },
+        {
+          "title": "Boolean Value",
+          "description": "A boolean value.",
+          "type": "boolean"
+        },
+        {
+          "title": "String Array",
+          "description": "An array of strings.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      ]
+    },
+    "type.snippet-definition-select-value": {
+      "id": "type.snippet-definition-select-value",
+      "title": "Snippet Definition Select Value",
+      "description": "A value option for select inputs, typically used in language lists.",
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The display name for this option.",
+          "type": "string"
+        },
+        "value": {
+          "description": "The value for this option.",
+          "anyOf": [
+            {
+              "title": "String",
+              "type": "string"
+            },
+            {
+              "title": "Number",
+              "type": "number"
+            },
+            {
+              "title": "Boolean",
+              "type": "boolean"
+            }
+          ]
+        }
+      },
+      "required": [
+        "value"
+      ],
+      "additionalProperties": false
     }
   }
 }

package/dist/cloudcannon-config.latest.schema.json

@@ -13177,14 +13177,128 @@
     },
     "type._snippets_definitions": {
       "title": "Snippets Definitions",
-      "description": "This key defines extended options used when creating more complex custom snippets.",
+      "description": "A record of reusable values that can be referenced in snippet templates. Values are substituted using `{ ref: \"key\" }` for direct replacement or `{ spread_ref: \"key\" }` for spreading arrays/objects. Common definition types include parser formats, argument models, select option lists, and simple string values like shortcode names.\n\n## Examples\n\nDefine reusable values like shortcode names, argument models, and parser formats that can be referenced in snippet templates.\n\n```yaml\n_snippets_definitions:\n  # Simple string value for the shortcode name\n  shortcode_name: \"highlight\"\n  content_key: \"content\"\n\n  # Array of argument models for positional arguments\n  positional_args:\n    - editor_key: \"language\"\n      type: \"string\"\n    - editor_key: \"linenos\"\n      type: \"boolean\"\n      optional: true\n      default: false\n\n  # Parser format configuration\n  custom_format:\n    root_pair_delimiter:\n      - \" \"\n    root_value_delimiter: \"=\"\n    string_boundary:\n      - '\"'\n      - \"'\"\n      - \"\"\n    allow_booleans: true\n    allow_numbers: true\n```\n\nReference definitions in snippet templates using `{ ref: \"key\" }` syntax. This allows you to reuse common configurations across multiple snippets.\n\n```yaml\n_snippets_definitions:\n  shortcode_name: \"figure\"\n  named_args:\n    - editor_key: \"src\"\n      type: \"string\"\n    - editor_key: \"alt\"\n      type: \"string\"\n      optional: true\n\n_snippets_templates:\n  my_shortcode_template:\n    snippet: \"{{< [[name]] [[args]] >}}\"\n    params:\n      name:\n        parser: \"literal\"\n        options:\n          literal:\n            ref: \"shortcode_name\"\n      args:\n        parser: \"key_values\"\n        options:\n          models:\n            ref: \"named_args\"\n\n_snippets:\n  figure:\n    template: \"my_shortcode_template\"\n    definitions:\n      shortcode_name: \"figure\"\n      named_args:\n        - editor_key: \"src\"\n          type: \"string\"\n        - editor_key: \"alt\"\n          type: \"string\"\n```\n\nDefine a list of select options for use in snippet inputs, such as a list of programming languages for a code highlighting snippet.\n\n```yaml\n_snippets_definitions:\n  languages:\n    - name: \"JavaScript\"\n      value: \"js\"\n    - name: \"Python\"\n      value: \"python\"\n    - name: \"Ruby\"\n      value: \"ruby\"\n    - name: \"HTML\"\n      value: \"html\"\n    - name: \"CSS\"\n      value: \"css\"\n```",
       "type": "object",
       "propertyNames": {
         "type": "string"
       },
-      "additionalProperties": {},
+      "additionalProperties": {
+        "$ref": "#/definitions/type.snippet-definition-value"
+      },
       "documented": true,
-      "markdownDescription": "This key defines extended options used when creating more complex custom snippets."
+      "markdownDescription": "A record of reusable values that can be referenced in snippet templates. Values are substituted using `{ ref: \"key\" }` for direct replacement or `{ spread_ref: \"key\" }` for spreading arrays/objects. Common definition types include parser formats, argument models, select option lists, and simple string values like shortcode names.\n\n## Examples\n\nDefine reusable values like shortcode names, argument models, and parser formats that can be referenced in snippet templates.\n\n```yaml\n_snippets_definitions:\n  # Simple string value for the shortcode name\n  shortcode_name: \"highlight\"\n  content_key: \"content\"\n\n  # Array of argument models for positional arguments\n  positional_args:\n    - editor_key: \"language\"\n      type: \"string\"\n    - editor_key: \"linenos\"\n      type: \"boolean\"\n      optional: true\n      default: false\n\n  # Parser format configuration\n  custom_format:\n    root_pair_delimiter:\n      - \" \"\n    root_value_delimiter: \"=\"\n    string_boundary:\n      - '\"'\n      - \"'\"\n      - \"\"\n    allow_booleans: true\n    allow_numbers: true\n```\n\nReference definitions in snippet templates using `{ ref: \"key\" }` syntax. This allows you to reuse common configurations across multiple snippets.\n\n```yaml\n_snippets_definitions:\n  shortcode_name: \"figure\"\n  named_args:\n    - editor_key: \"src\"\n      type: \"string\"\n    - editor_key: \"alt\"\n      type: \"string\"\n      optional: true\n\n_snippets_templates:\n  my_shortcode_template:\n    snippet: \"{{< [[name]] [[args]] >}}\"\n    params:\n      name:\n        parser: \"literal\"\n        options:\n          literal:\n            ref: \"shortcode_name\"\n      args:\n        parser: \"key_values\"\n        options:\n          models:\n            ref: \"named_args\"\n\n_snippets:\n  figure:\n    template: \"my_shortcode_template\"\n    definitions:\n      shortcode_name: \"figure\"\n      named_args:\n        - editor_key: \"src\"\n          type: \"string\"\n        - editor_key: \"alt\"\n          type: \"string\"\n```\n\nDefine a list of select options for use in snippet inputs, such as a list of programming languages for a code highlighting snippet.\n\n```yaml\n_snippets_definitions:\n  languages:\n    - name: \"JavaScript\"\n      value: \"js\"\n    - name: \"Python\"\n      value: \"python\"\n    - name: \"Ruby\"\n      value: \"ruby\"\n    - name: \"HTML\"\n      value: \"html\"\n    - name: \"CSS\"\n      value: \"css\"\n```"
+    },
+    "type.snippet-definition-value": {
+      "title": "Snippet Definition Value",
+      "description": "A reusable value that can be referenced in snippet templates via `{ ref: \"key\" }` or `{ spread_ref: \"key\" }`. Can be a string, number, boolean, parser format, parser model, array of models, or array of select options.",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/type.snippet-format"
+        },
+        {
+          "$ref": "#/definitions/type.snippet-model"
+        },
+        {
+          "title": "Parser Model Array",
+          "description": "An array of parser model configurations. Typically used for `positional_args` or `named_args` definitions that specify the arguments a snippet accepts. Each model defines an argument's editor key, type, default value, and whether it's optional.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/type.snippet-model"
+          },
+          "documented": true,
+          "markdownDescription": "An array of parser model configurations. Typically used for `positional_args` or `named_args` definitions that specify the arguments a snippet accepts. Each model defines an argument's editor key, type, default value, and whether it's optional."
+        },
+        {
+          "title": "Select Values Array",
+          "description": "An array of select option values. Commonly used for language lists in code highlighting snippets, where each option has a display name and a value. For example: `[{ name: \"JavaScript\", value: \"js\" }, { name: \"Python\", value: \"python\" }]`.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/type.snippet-definition-select-value"
+          },
+          "documented": true,
+          "markdownDescription": "An array of select option values. Commonly used for language lists in code highlighting snippets, where each option has a display name and a value. For example: `[{ name: \"JavaScript\", value: \"js\" }, { name: \"Python\", value: \"python\" }]`."
+        },
+        {
+          "title": "String Value",
+          "description": "A string value definition. Commonly used for `shortcode_name`, `tag_name`, `content_key`, `include_name`, and similar definitions that identify snippet components by name.",
+          "type": "string",
+          "documented": true,
+          "markdownDescription": "A string value definition. Commonly used for `shortcode_name`, `tag_name`, `content_key`, `include_name`, and similar definitions that identify snippet components by name."
+        },
+        {
+          "title": "Number Value",
+          "description": "A numeric value definition. Use for counts, sizes, or other numeric values that can be referenced in snippet templates.",
+          "type": "number",
+          "documented": true,
+          "markdownDescription": "A numeric value definition. Use for counts, sizes, or other numeric values that can be referenced in snippet templates."
+        },
+        {
+          "title": "Boolean Value",
+          "description": "A boolean value definition. Use for flags and toggles that can be referenced in snippet templates.",
+          "type": "boolean",
+          "documented": true,
+          "markdownDescription": "A boolean value definition. Use for flags and toggles that can be referenced in snippet templates."
+        },
+        {
+          "title": "String Array",
+          "description": "An array of string values. Useful for defining lists of allowed values, delimiters, or other string collections that can be referenced in snippet templates.",
+          "type": "array",
+          "items": {
+            "type": "string",
+            "documented": true,
+            "title": "snippet-definition-value(string-array)[*]",
+            "description": "A string item in the array.",
+            "markdownDescription": "A string item in the array."
+          },
+          "documented": true,
+          "markdownDescription": "An array of string values. Useful for defining lists of allowed values, delimiters, or other string collections that can be referenced in snippet templates."
+        }
+      ],
+      "documented": true,
+      "markdownDescription": "A reusable value that can be referenced in snippet templates via `{ ref: \"key\" }` or `{ spread_ref: \"key\" }`. Can be a string, number, boolean, parser format, parser model, array of models, or array of select options."
+    },
+    "type.snippet-definition-select-value": {
+      "title": "Snippet Definition Select Value",
+      "description": "A value option for select inputs, typically used in language lists. Contains a display name and the actual value to use.",
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The display name shown to users when selecting this option. For example, \"JavaScript\" for a language with value \"js\".",
+          "type": "string",
+          "documented": true,
+          "title": "name",
+          "markdownDescription": "The display name shown to users when selecting this option. For example, \"JavaScript\" for a language with value \"js\"."
+        },
+        "value": {
+          "description": "The actual value used when this option is selected. Can be a string, number, or boolean. For example, \"js\" for JavaScript or 4 for an indentation level.",
+          "anyOf": [
+            {
+              "title": "String Select Value",
+              "type": "string",
+              "documented": true
+            },
+            {
+              "title": "Number Select Value",
+              "type": "number",
+              "documented": true
+            },
+            {
+              "title": "Boolean Select Value",
+              "type": "boolean",
+              "documented": true
+            }
+          ],
+          "documented": true,
+          "title": "value",
+          "markdownDescription": "The actual value used when this option is selected. Can be a string, number, or boolean. For example, \"js\" for JavaScript or 4 for an indentation level."
+        }
+      },
+      "required": [
+        "value"
+      ],
+      "additionalProperties": false,
+      "documented": true,
+      "markdownDescription": "A value option for select inputs, typically used in language lists. Contains a display name and the actual value to use."
     }
   },
   "documented": false,

package/dist/cloudcannon-config.legacy-eleventy.schema.json

@@ -11468,13 +11468,108 @@
     },
     "type._snippets_definitions": {
       "title": "Snippets Definitions",
-      "description": "Extended option used when creating more complex custom snippets.",
+      "description": "A record of reusable values that can be referenced in snippet templates. Values are substituted using { ref: \"key\" } for direct replacement or { spread_ref: \"key\" } for spreading arrays/objects.",
       "type": "object",
       "propertyNames": {
         "type": "string"
       },
-      "additionalProperties": {},
-      "markdownDescription": "Extended option used when creating more complex custom snippets."
+      "additionalProperties": {
+        "$ref": "#/definitions/type.snippet-definition-value"
+      },
+      "markdownDescription": "A record of reusable values that can be referenced in snippet templates. Values are substituted using { ref: \"key\" } for direct replacement or { spread_ref: \"key\" } for spreading arrays/objects."
+    },
+    "type.snippet-definition-value": {
+      "title": "Snippet Definition Value",
+      "description": "A reusable value that can be referenced in snippet templates via { ref: \"key\" } or { spread_ref: \"key\" }.",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/type.snippet-format"
+        },
+        {
+          "$ref": "#/definitions/type.snippet-model"
+        },
+        {
+          "title": "Parser Model Array",
+          "description": "An array of model configurations, typically used for positional_args or named_args.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/type.snippet-model"
+          },
+          "markdownDescription": "An array of model configurations, typically used for positional_args or named_args."
+        },
+        {
+          "title": "Select Values Array",
+          "description": "An array of select options, typically used for language lists.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/type.snippet-definition-select-value"
+          },
+          "markdownDescription": "An array of select options, typically used for language lists."
+        },
+        {
+          "title": "String Value",
+          "description": "A string value, commonly used for shortcode_name, tag_name, content_key, and similar definitions.",
+          "type": "string",
+          "markdownDescription": "A string value, commonly used for shortcode_name, tag_name, content_key, and similar definitions."
+        },
+        {
+          "title": "Number Value",
+          "description": "A numeric value.",
+          "type": "number",
+          "markdownDescription": "A numeric value."
+        },
+        {
+          "title": "Boolean Value",
+          "description": "A boolean value.",
+          "type": "boolean",
+          "markdownDescription": "A boolean value."
+        },
+        {
+          "title": "String Array",
+          "description": "An array of strings.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "markdownDescription": "An array of strings."
+        }
+      ],
+      "markdownDescription": "A reusable value that can be referenced in snippet templates via { ref: \"key\" } or { spread_ref: \"key\" }."
+    },
+    "type.snippet-definition-select-value": {
+      "title": "Snippet Definition Select Value",
+      "description": "A value option for select inputs, typically used in language lists.",
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The display name for this option.",
+          "type": "string",
+          "markdownDescription": "The display name for this option."
+        },
+        "value": {
+          "description": "The value for this option.",
+          "anyOf": [
+            {
+              "title": "String",
+              "type": "string"
+            },
+            {
+              "title": "Number",
+              "type": "number"
+            },
+            {
+              "title": "Boolean",
+              "type": "boolean"
+            }
+          ],
+          "markdownDescription": "The value for this option."
+        }
+      },
+      "required": [
+        "value"
+      ],
+      "additionalProperties": false,
+      "markdownDescription": "A value option for select inputs, typically used in language lists."
     },
     "collections_config_override": {
       "description": "Prevents CloudCannon from automatically discovering collections for supported SSGs if true. Defaults to false.",

package/dist/cloudcannon-config.legacy-hugo.schema.json

@@ -11471,13 +11471,108 @@
     },
     "type._snippets_definitions": {
       "title": "Snippets Definitions",
-      "description": "Extended option used when creating more complex custom snippets.",
+      "description": "A record of reusable values that can be referenced in snippet templates. Values are substituted using { ref: \"key\" } for direct replacement or { spread_ref: \"key\" } for spreading arrays/objects.",
       "type": "object",
       "propertyNames": {
         "type": "string"
       },
-      "additionalProperties": {},
-      "markdownDescription": "Extended option used when creating more complex custom snippets."
+      "additionalProperties": {
+        "$ref": "#/definitions/type.snippet-definition-value"
+      },
+      "markdownDescription": "A record of reusable values that can be referenced in snippet templates. Values are substituted using { ref: \"key\" } for direct replacement or { spread_ref: \"key\" } for spreading arrays/objects."
+    },
+    "type.snippet-definition-value": {
+      "title": "Snippet Definition Value",
+      "description": "A reusable value that can be referenced in snippet templates via { ref: \"key\" } or { spread_ref: \"key\" }.",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/type.snippet-format"
+        },
+        {
+          "$ref": "#/definitions/type.snippet-model"
+        },
+        {
+          "title": "Parser Model Array",
+          "description": "An array of model configurations, typically used for positional_args or named_args.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/type.snippet-model"
+          },
+          "markdownDescription": "An array of model configurations, typically used for positional_args or named_args."
+        },
+        {
+          "title": "Select Values Array",
+          "description": "An array of select options, typically used for language lists.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/type.snippet-definition-select-value"
+          },
+          "markdownDescription": "An array of select options, typically used for language lists."
+        },
+        {
+          "title": "String Value",
+          "description": "A string value, commonly used for shortcode_name, tag_name, content_key, and similar definitions.",
+          "type": "string",
+          "markdownDescription": "A string value, commonly used for shortcode_name, tag_name, content_key, and similar definitions."
+        },
+        {
+          "title": "Number Value",
+          "description": "A numeric value.",
+          "type": "number",
+          "markdownDescription": "A numeric value."
+        },
+        {
+          "title": "Boolean Value",
+          "description": "A boolean value.",
+          "type": "boolean",
+          "markdownDescription": "A boolean value."
+        },
+        {
+          "title": "String Array",
+          "description": "An array of strings.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "markdownDescription": "An array of strings."
+        }
+      ],
+      "markdownDescription": "A reusable value that can be referenced in snippet templates via { ref: \"key\" } or { spread_ref: \"key\" }."
+    },
+    "type.snippet-definition-select-value": {
+      "title": "Snippet Definition Select Value",
+      "description": "A value option for select inputs, typically used in language lists.",
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The display name for this option.",
+          "type": "string",
+          "markdownDescription": "The display name for this option."
+        },
+        "value": {
+          "description": "The value for this option.",
+          "anyOf": [
+            {
+              "title": "String",
+              "type": "string"
+            },
+            {
+              "title": "Number",
+              "type": "number"
+            },
+            {
+              "title": "Boolean",
+              "type": "boolean"
+            }
+          ],
+          "markdownDescription": "The value for this option."
+        }
+      },
+      "required": [
+        "value"
+      ],
+      "additionalProperties": false,
+      "markdownDescription": "A value option for select inputs, typically used in language lists."
     },
     "collections_config_override": {
       "description": "Prevents CloudCannon from automatically discovering collections for supported SSGs if true. Defaults to false.",

package/dist/cloudcannon-config.legacy-jekyll.schema.json

@@ -11468,13 +11468,108 @@
     },
     "type._snippets_definitions": {
       "title": "Snippets Definitions",
-      "description": "Extended option used when creating more complex custom snippets.",
+      "description": "A record of reusable values that can be referenced in snippet templates. Values are substituted using { ref: \"key\" } for direct replacement or { spread_ref: \"key\" } for spreading arrays/objects.",
       "type": "object",
       "propertyNames": {
         "type": "string"
       },
-      "additionalProperties": {},
-      "markdownDescription": "Extended option used when creating more complex custom snippets."
+      "additionalProperties": {
+        "$ref": "#/definitions/type.snippet-definition-value"
+      },
+      "markdownDescription": "A record of reusable values that can be referenced in snippet templates. Values are substituted using { ref: \"key\" } for direct replacement or { spread_ref: \"key\" } for spreading arrays/objects."
+    },
+    "type.snippet-definition-value": {
+      "title": "Snippet Definition Value",
+      "description": "A reusable value that can be referenced in snippet templates via { ref: \"key\" } or { spread_ref: \"key\" }.",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/type.snippet-format"
+        },
+        {
+          "$ref": "#/definitions/type.snippet-model"
+        },
+        {
+          "title": "Parser Model Array",
+          "description": "An array of model configurations, typically used for positional_args or named_args.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/type.snippet-model"
+          },
+          "markdownDescription": "An array of model configurations, typically used for positional_args or named_args."
+        },
+        {
+          "title": "Select Values Array",
+          "description": "An array of select options, typically used for language lists.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/type.snippet-definition-select-value"
+          },
+          "markdownDescription": "An array of select options, typically used for language lists."
+        },
+        {
+          "title": "String Value",
+          "description": "A string value, commonly used for shortcode_name, tag_name, content_key, and similar definitions.",
+          "type": "string",
+          "markdownDescription": "A string value, commonly used for shortcode_name, tag_name, content_key, and similar definitions."
+        },
+        {
+          "title": "Number Value",
+          "description": "A numeric value.",
+          "type": "number",
+          "markdownDescription": "A numeric value."
+        },
+        {
+          "title": "Boolean Value",
+          "description": "A boolean value.",
+          "type": "boolean",
+          "markdownDescription": "A boolean value."
+        },
+        {
+          "title": "String Array",
+          "description": "An array of strings.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "markdownDescription": "An array of strings."
+        }
+      ],
+      "markdownDescription": "A reusable value that can be referenced in snippet templates via { ref: \"key\" } or { spread_ref: \"key\" }."
+    },
+    "type.snippet-definition-select-value": {
+      "title": "Snippet Definition Select Value",
+      "description": "A value option for select inputs, typically used in language lists.",
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The display name for this option.",
+          "type": "string",
+          "markdownDescription": "The display name for this option."
+        },
+        "value": {
+          "description": "The value for this option.",
+          "anyOf": [
+            {
+              "title": "String",
+              "type": "string"
+            },
+            {
+              "title": "Number",
+              "type": "number"
+            },
+            {
+              "title": "Boolean",
+              "type": "boolean"
+            }
+          ],
+          "markdownDescription": "The value for this option."
+        }
+      },
+      "required": [
+        "value"
+      ],
+      "additionalProperties": false,
+      "markdownDescription": "A value option for select inputs, typically used in language lists."
     },
     "collections_config_override": {
       "description": "Prevents CloudCannon from automatically discovering collections for supported SSGs if true. Defaults to false.",