@allejo/decap-extras 0.0.6 → 0.0.8

package/dist/index.mjs

@@ -1,4 +1,38 @@
 //#region src/widgets.ts
+/**
+* Marks a widget field as optional, allowing it to be left empty in DecapCMS.
+* This modifier can be applied to any widget type to make it non-required.
+*
+* **DecapCMS Configuration (TypeScript)**
+*
+* ```typescript
+* optional(stringWidget("Middle Name", "middleName"))
+* ```
+*
+* **DecapCMS Configuration (YAML)**
+*
+* ```yaml
+* - label: Middle Name
+*   name: middleName
+*   widget: string
+*   required: false
+* ```
+*
+* **Data Store YAML**
+*
+* ```yaml
+* middleName: # Can be left empty
+* ```
+*
+* The `optional` modifier can be used with all widget types including complex ones:
+*
+* ```typescript
+* optional(objectWidget("Metadata", "metadata", [stringWidget("Author", "author")]))
+* optional(listWidget("Tags", "tags", stringWidget("Tag", "value")))
+* ```
+*
+* @link https://decapcms.org/docs/widgets/#common-widget-options
+*/
 function optional(widget) {
 	return {
 		...widget,
@@ -6,6 +40,40 @@ function optional(widget) {
 		__optional: true
 	};
 }
+/**
+* Creates a Boolean widget configuration with the given label and name, and
+* optional additional options.
+*
+* **DecapCMS Configuration (TypeScript)**
+*
+* ```typescript
+* boolWidget("Published", "published")
+* ```
+*
+* **DecapCMS Configuration (YAML)**
+*
+* ```yaml
+* - label: Published
+*   name: published
+*   widget: boolean
+* ```
+*
+* **Data Store YAML**
+*
+* ```yaml
+* published: true
+* ```
+*
+* The boolean widget creates a checkbox input in the editor. This can be made
+* optional using the `optional` modifier:
+*
+* ```typescript
+* optional(boolWidget("Draft", "isDraft"))
+* ```
+*
+* @see optional
+* @link https://decapcms.org/docs/widgets/#boolean
+*/
 function boolWidget(label, name, options) {
 	return {
 		label,
@@ -14,6 +82,40 @@ function boolWidget(label, name, options) {
 		...options ?? {}
 	};
 }
+/**
+* Creates an Image widget configuration with the given label and name, and
+* optional additional options.
+*
+* **DecapCMS Configuration (TypeScript)**
+*
+* ```typescript
+* imageWidget("Featured Image", "featuredImage")
+* ```
+*
+* **DecapCMS Configuration (YAML)**
+*
+* ```yaml
+* - label: Featured Image
+*   name: featuredImage
+*   widget: image
+* ```
+*
+* **Data Store YAML**
+*
+* ```yaml
+* featuredImage: /images/hero.jpg
+* ```
+*
+* The image widget provides file upload functionality with image preview
+* capabilities. It can be made optional using the `optional` modifier:
+*
+* ```typescript
+* optional(imageWidget("Avatar", "avatar"))
+* ```
+*
+* @see optional
+* @link https://decapcms.org/docs/widgets/#image
+*/
 function imageWidget(label, name, options) {
 	return {
 		label,
@@ -28,9 +130,51 @@ function listWidget(label, name, fields, options) {
 		name,
 		widget: "list",
 		...options ?? {},
-		...Array.isArray(fields) ? { fields } : { field: fields }
+		...Array.isArray(fields) ? { fields } : fields.widget === "object" ? { fields: fields.fields } : { field: fields }
 	};
 }
+/**
+* Creates a Markdown widget configuration with the given label and name, and
+* optional additional options.
+*
+* **DecapCMS Configuration (TypeScript)**
+*
+* ```typescript
+* markdownWidget("Biography", "biography")
+* ```
+*
+* **DecapCMS Configuration (YAML)**
+*
+* ```yaml
+* - label: Biography
+*   name: biography
+*   widget: richtext
+* ```
+*
+* **Data Store YAML**
+*
+* ```yaml
+* biography: |-
+*   Hello, world. I was born in the year 2000.
+* ```
+*
+* There are pre-configured constants available for use with the `options`
+* parameter:
+*
+* - INLINE_MARKDOWN
+* - RICH_MARKDOWN
+*
+* For example, to use the `RICH_MARKDOWN` configuration, you can do the following:
+*
+* ```typescript
+* markdownWidget("Biography", "biography", RICH_MARKDOWN)
+* ```
+*
+* @see INLINE_MARKDOWN
+* @see RICH_MARKDOWN
+*
+* @link https://decapcms.org/docs/widgets/#Richtext%20(Beta)
+*/
 function markdownWidget(label, name, options) {
 	return {
 		label,
@@ -39,6 +183,58 @@ function markdownWidget(label, name, options) {
 		...options ?? {}
 	};
 }
+/**
+* Creates an Object widget configuration with the given label, name, fields, and
+* optional additional options.
+*
+* The object widget groups multiple fields together as a nested object in the
+* data store. This is useful for creating structured data with related properties.
+*
+* **DecapCMS Configuration (TypeScript)**
+*
+* ```typescript
+* objectWidget("Author", "author", [
+*   stringWidget("Name", "name"),
+*   stringWidget("Email", "email"),
+* ])
+* ```
+*
+* **DecapCMS Configuration (YAML)**
+*
+* ```yaml
+* - label: Author
+*   name: author
+*   widget: object
+*   fields:
+*     - label: Name
+*       name: name
+*       widget: string
+*     - label: Email
+*       name: email
+*       widget: string
+* ```
+*
+* **Data Store YAML**
+*
+* ```yaml
+* author:
+*   name: Jane Doe
+*   email: jane@example.com
+* ```
+*
+* Objects can be nested within lists or other objects to create complex data
+* structures. They can also be made optional using the `optional` modifier:
+*
+* ```typescript
+* optional(objectWidget("Metadata", "metadata", [
+*   stringWidget("SEO Title", "seoTitle"),
+*   textWidget("Description", "description"),
+* ]))
+* ```
+*
+* @see optional
+* @link https://decapcms.org/docs/widgets/#object
+*/
 function objectWidget(label, name, fields, options) {
 	return {
 		label,
@@ -48,6 +244,40 @@ function objectWidget(label, name, fields, options) {
 		fields
 	};
 }
+/**
+* Creates a Number widget configuration with the given label and name, and
+* optional additional options.
+*
+* **DecapCMS Configuration (TypeScript)**
+*
+* ```typescript
+* numberWidget("Priority", "priority")
+* ```
+*
+* **DecapCMS Configuration (YAML)**
+*
+* ```yaml
+* - label: Priority
+*   name: priority
+*   widget: number
+* ```
+*
+* **Data Store YAML**
+*
+* ```yaml
+* priority: 1
+* ```
+*
+* The number widget provides numeric input with optional min, max, and step
+* constraints. It can be made optional using the `optional` modifier:
+*
+* ```typescript
+* optional(numberWidget("Views", "views"))
+* ```
+*
+* @see optional
+* @link https://decapcms.org/docs/widgets/#number
+*/
 function numberWidget(label, name, options) {
 	return {
 		label,
@@ -56,6 +286,46 @@ function numberWidget(label, name, options) {
 		...options ?? {}
 	};
 }
+/**
+* Creates a Select widget configuration with the given label, name, choices, and
+* optional additional options.
+*
+* The select widget creates a dropdown menu with predefined options. The `choices`
+* array becomes the available options in the YAML configuration.
+*
+* **DecapCMS Configuration (TypeScript)**
+*
+* ```typescript
+* selectWidget("Status", "status", ["draft", "published", "archived"] as const)
+* ```
+*
+* **DecapCMS Configuration (YAML)**
+*
+* ```yaml
+* - label: Status
+*   name: status
+*   widget: select
+*   options:
+*     - draft
+*     - published
+*     - archived
+* ```
+*
+* **Data Store YAML**
+*
+* ```yaml
+* status: published
+* ```
+*
+* The select widget can be made optional using the `optional` modifier:
+*
+* ```typescript
+* optional(selectWidget("Category", "category", ["tech", "lifestyle", "business"] as const))
+* ```
+*
+* @see optional
+* @link https://decapcms.org/docs/widgets/#select
+*/
 function selectWidget(label, name, choices, options) {
 	return {
 		label,
@@ -65,6 +335,44 @@ function selectWidget(label, name, choices, options) {
 		options: choices ?? []
 	};
 }
+/**
+* Creates a String widget configuration with the given label and name, and
+* optional additional options.
+*
+* The string widget provides a single-line text input field for short text content.
+* Unlike the text widget which provides multi-line input, the string widget is
+* designed for concise, single-line values.
+*
+* **DecapCMS Configuration (TypeScript)**
+*
+* ```typescript
+* stringWidget("Title", "title")
+* ```
+*
+* **DecapCMS Configuration (YAML)**
+*
+* ```yaml
+* - label: Title
+*   name: title
+*   widget: string
+* ```
+*
+* **Data Store YAML**
+*
+* ```yaml
+* title: Welcome to My Blog
+* ```
+*
+* The string widget can be made optional using the `optional` modifier:
+*
+* ```typescript
+* optional(stringWidget("Slug", "slug"))
+* ```
+*
+* @see optional
+* @see textWidget
+* @link https://decapcms.org/docs/widgets/#string
+*/
 function stringWidget(label, name, options) {
 	return {
 		label,
@@ -73,6 +381,47 @@ function stringWidget(label, name, options) {
 		...options ?? {}
 	};
 }
+/**
+* Creates a Text widget configuration with the given label and name, and
+* optional additional options.
+*
+* The text widget provides a multi-line text input field for longer text content.
+* Unlike the string widget which provides single-line input, the text widget is
+* designed for paragraphs and multi-line content.
+*
+* **DecapCMS Configuration (TypeScript)**
+*
+* ```typescript
+* textWidget("Description", "description")
+* ```
+*
+* **DecapCMS Configuration (YAML)**
+*
+* ```yaml
+* - label: Description
+*   name: description
+*   widget: text
+* ```
+*
+* **Data Store YAML**
+*
+* ```yaml
+* description: |-
+*   This is a longer description that spans
+*   multiple lines in the data store.
+* ```
+*
+* The text widget can be made optional using the `optional` modifier:
+*
+* ```typescript
+* optional(textWidget("Notes", "notes"))
+* ```
+*
+* @see optional
+* @see stringWidget
+* @see markdownWidget
+* @link https://decapcms.org/docs/widgets/#text
+*/
 function textWidget(label, name, options) {
 	return {
 		label,

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/widgets.ts"],"sourcesContent":["import type {\n\tCmsField,\n\tCmsFieldBoolean,\n\tCmsFieldFileOrImage,\n\tCmsFieldList,\n\tCmsFieldMarkdown,\n\tCmsFieldNumber,\n\tCmsFieldObject,\n\tCmsFieldSelect,\n\tCmsFieldStringOrText,\n} from 'decap-cms-core';\n\nimport type { OptionalWidget, WidgetOpts } from './api.js';\n\n// Widget Modifiers\n\nexport function optional<T extends CmsField>(widget: T): OptionalWidget<T> {\n\treturn {\n\t\t...widget,\n\t\trequired: false as const,\n\t\t__optional: true as const,\n\t};\n}\n\n// Primitive Widgets\n\nexport function boolWidget<T extends string>(\n\tlabel: string,\n\tname: T,\n\toptions?: WidgetOpts<CmsFieldBoolean>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'boolean',\n\t\t...(options ?? {}),\n\t} as const satisfies CmsField;\n}\n\nexport function imageWidget<T extends string>(\n\tlabel: string,\n\tname: T,\n\toptions?: WidgetOpts<CmsFieldFileOrImage>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'image',\n\t\t...(options ?? {}),\n\t} as const satisfies CmsField;\n}\n\nexport function listWidget<T extends string, F extends CmsField>(\n\tlabel: string,\n\tname: T,\n\tfields: F,\n\toptions?: WidgetOpts<CmsFieldList>,\n): { label: string; name: T; widget: 'list'; field: F };\nexport function listWidget<T extends string, F extends CmsField[]>(\n\tlabel: string,\n\tname: T,\n\tfields: F,\n\toptions?: WidgetOpts<CmsFieldList>,\n): { label: string; name: T; widget: 'list'; fields: F };\nexport function listWidget<T extends string, F extends CmsField | CmsField[]>(\n\tlabel: string,\n\tname: T,\n\tfields: F,\n\toptions?: WidgetOpts<CmsFieldList>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'list',\n\t\t...(options ?? {}),\n\t\t...(Array.isArray(fields) ? { fields } : { field: fields }),\n\t} as const;\n}\n\nexport function markdownWidget<T extends string>(\n\tlabel: string,\n\tname: T,\n\toptions?: WidgetOpts<CmsFieldMarkdown>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'richtext' as 'string',\n\t\t...(options ?? {}),\n\t} as const satisfies CmsField;\n}\n\nexport function objectWidget<T extends string, F extends CmsField[]>(\n\tlabel: string,\n\tname: T,\n\tfields: F,\n\toptions?: WidgetOpts<CmsFieldObject>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'object',\n\t\t...(options ?? {}),\n\t\tfields,\n\t} as const satisfies CmsField;\n}\n\nexport function numberWidget<T extends string>(\n\tlabel: string,\n\tname: T,\n\toptions?: WidgetOpts<CmsFieldNumber>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'number',\n\t\t...(options ?? {}),\n\t} as const satisfies CmsField;\n}\n\nexport function selectWidget<T extends string, O extends string[]>(\n\tlabel: string,\n\tname: T,\n\tchoices: O,\n\toptions?: WidgetOpts<CmsFieldSelect>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'select',\n\t\t...(options ?? {}),\n\t\toptions: choices ?? [],\n\t} as const satisfies CmsField;\n}\n\nexport function stringWidget<T extends string>(\n\tlabel: string,\n\tname: T,\n\toptions?: WidgetOpts<CmsFieldStringOrText>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'string',\n\t\t...(options ?? {}),\n\t} as const satisfies CmsField;\n}\n\nexport function textWidget<T extends string>(\n\tlabel: string,\n\tname: T,\n\toptions?: WidgetOpts<CmsFieldStringOrText>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'text',\n\t\t...(options ?? {}),\n\t} as const satisfies CmsField;\n}\n\n// Reusable Widget Configurations\n\n/**\n * Stripped down Markdown widget configuration that does the following:\n *\n * - Allows bold, italic, lists (bullet + numbered), quotes\n * - No images or code block components\n * - Rich Text preview only\n */\nexport const RICH_MARKDOWN: WidgetOpts<CmsFieldMarkdown> = {\n\tbuttons: [\n\t\t'bold',\n\t\t'bulleted-list',\n\t\t'italic',\n\t\t'link',\n\t\t'numbered-list',\n\t\t'quote',\n\t],\n\teditor_components: [],\n\tmodes: ['rich_text'],\n};\n\n/**\n * Stripped down Markdown Widget configuration that allows only inline\n * elements (e.g., no lists, quotes, or headings) and rich text preview only.\n */\nexport const INLINE_MARKDOWN: WidgetOpts<CmsFieldMarkdown> = {\n\tbuttons: ['bold', 'italic', 'link'],\n\teditor_components: [],\n\tmodes: ['rich_text'],\n};\n"],"mappings":";AAgBA,SAAgB,SAA6B,QAA8B;CAC1E,OAAO;EACN,GAAG;EACH,UAAU;EACV,YAAY;CACb;AACD;AAIA,SAAgB,WACf,OACA,MACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;CACjB;AACD;AAEA,SAAgB,YACf,OACA,MACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;CACjB;AACD;AAcA,SAAgB,WACf,OACA,MACA,QACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;EAChB,GAAI,MAAM,QAAQ,MAAM,IAAI,EAAE,OAAO,IAAI,EAAE,OAAO,OAAO;CAC1D;AACD;AAEA,SAAgB,eACf,OACA,MACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;CACjB;AACD;AAEA,SAAgB,aACf,OACA,MACA,QACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;EAChB;CACD;AACD;AAEA,SAAgB,aACf,OACA,MACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;CACjB;AACD;AAEA,SAAgB,aACf,OACA,MACA,SACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;EAChB,SAAS,WAAW,CAAC;CACtB;AACD;AAEA,SAAgB,aACf,OACA,MACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;CACjB;AACD;AAEA,SAAgB,WACf,OACA,MACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;CACjB;AACD;;;;;;;;AAWA,MAAa,gBAA8C;CAC1D,SAAS;EACR;EACA;EACA;EACA;EACA;EACA;CACD;CACA,mBAAmB,CAAC;CACpB,OAAO,CAAC,WAAW;AACpB;;;;;AAMA,MAAa,kBAAgD;CAC5D,SAAS;EAAC;EAAQ;EAAU;CAAM;CAClC,mBAAmB,CAAC;CACpB,OAAO,CAAC,WAAW;AACpB"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/widgets.ts"],"sourcesContent":["import type {\n\tCmsField,\n\tCmsFieldBoolean,\n\tCmsFieldFileOrImage,\n\tCmsFieldList,\n\tCmsFieldMarkdown,\n\tCmsFieldNumber,\n\tCmsFieldObject,\n\tCmsFieldSelect,\n\tCmsFieldStringOrText,\n} from 'decap-cms-core';\n\nimport type { OptionalWidget, WidgetOpts } from './api.js';\n\n// Widget Modifiers\n\n/**\n * Marks a widget field as optional, allowing it to be left empty in DecapCMS.\n * This modifier can be applied to any widget type to make it non-required.\n *\n * **DecapCMS Configuration (TypeScript)**\n *\n * ```typescript\n * optional(stringWidget(\"Middle Name\", \"middleName\"))\n * ```\n *\n * **DecapCMS Configuration (YAML)**\n *\n * ```yaml\n * - label: Middle Name\n *   name: middleName\n *   widget: string\n *   required: false\n * ```\n *\n * **Data Store YAML**\n *\n * ```yaml\n * middleName: # Can be left empty\n * ```\n *\n * The `optional` modifier can be used with all widget types including complex ones:\n *\n * ```typescript\n * optional(objectWidget(\"Metadata\", \"metadata\", [stringWidget(\"Author\", \"author\")]))\n * optional(listWidget(\"Tags\", \"tags\", stringWidget(\"Tag\", \"value\")))\n * ```\n *\n * @link https://decapcms.org/docs/widgets/#common-widget-options\n */\nexport function optional<T extends CmsField>(widget: T): OptionalWidget<T> {\n\treturn {\n\t\t...widget,\n\t\trequired: false as const,\n\t\t__optional: true as const,\n\t};\n}\n\n// Primitive Widgets\n\n/**\n * Creates a Boolean widget configuration with the given label and name, and\n * optional additional options.\n *\n * **DecapCMS Configuration (TypeScript)**\n *\n * ```typescript\n * boolWidget(\"Published\", \"published\")\n * ```\n *\n * **DecapCMS Configuration (YAML)**\n *\n * ```yaml\n * - label: Published\n *   name: published\n *   widget: boolean\n * ```\n *\n * **Data Store YAML**\n *\n * ```yaml\n * published: true\n * ```\n *\n * The boolean widget creates a checkbox input in the editor. This can be made\n * optional using the `optional` modifier:\n *\n * ```typescript\n * optional(boolWidget(\"Draft\", \"isDraft\"))\n * ```\n *\n * @see optional\n * @link https://decapcms.org/docs/widgets/#boolean\n */\nexport function boolWidget<T extends string>(\n\tlabel: string,\n\tname: T,\n\toptions?: WidgetOpts<CmsFieldBoolean>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'boolean',\n\t\t...(options ?? {}),\n\t} as const satisfies CmsField;\n}\n\n/**\n * Creates an Image widget configuration with the given label and name, and\n * optional additional options.\n *\n * **DecapCMS Configuration (TypeScript)**\n *\n * ```typescript\n * imageWidget(\"Featured Image\", \"featuredImage\")\n * ```\n *\n * **DecapCMS Configuration (YAML)**\n *\n * ```yaml\n * - label: Featured Image\n *   name: featuredImage\n *   widget: image\n * ```\n *\n * **Data Store YAML**\n *\n * ```yaml\n * featuredImage: /images/hero.jpg\n * ```\n *\n * The image widget provides file upload functionality with image preview\n * capabilities. It can be made optional using the `optional` modifier:\n *\n * ```typescript\n * optional(imageWidget(\"Avatar\", \"avatar\"))\n * ```\n *\n * @see optional\n * @link https://decapcms.org/docs/widgets/#image\n */\nexport function imageWidget<T extends string>(\n\tlabel: string,\n\tname: T,\n\toptions?: WidgetOpts<CmsFieldFileOrImage>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'image',\n\t\t...(options ?? {}),\n\t} as const satisfies CmsField;\n}\n\n/**\n * Creates a List widget configuration with the given label, name, field(s), and\n * optional additional options.\n *\n * The `listWidget` function accepts either a single field (which gets expanded\n * for object types) or an array of fields. When passed an object widget, its\n * fields are automatically extracted and expanded.\n *\n * **DecapCMS Configuration (TypeScript)**\n *\n * Single field example:\n *\n * ```typescript\n * listWidget(\"Tags\", \"tags\", stringWidget(\"Tag\", \"value\"))\n * ```\n *\n * Multiple fields example:\n *\n * ```typescript\n * listWidget(\"Authors\", \"authors\", [\n *   stringWidget(\"Name\", \"name\"),\n *   imageWidget(\"Avatar\", \"avatar\"),\n * ])\n * ```\n *\n * **DecapCMS Configuration (YAML)**\n *\n * Single field:\n *\n * ```yaml\n * - label: Tags\n *   name: tags\n *   widget: list\n *   field:\n *     label: Tag\n *     name: value\n *     widget: string\n * ```\n *\n * Multiple fields:\n *\n * ```yaml\n * - label: Authors\n *   name: authors\n *   widget: list\n *   fields:\n *     - label: Name\n *       name: name\n *       widget: string\n *     - label: Avatar\n *       name: avatar\n *       widget: image\n * ```\n *\n * **Data Store YAML**\n *\n * ```yaml\n * tags:\n *   - value: React\n *   - value: TypeScript\n *\n * authors:\n *   - name: Jane Doe\n *     avatar: /images/jane.jpg\n *   - name: John Smith\n *     avatar: /images/john.jpg\n * ```\n *\n * The list widget can be made optional using the `optional` modifier:\n *\n * ```typescript\n * optional(listWidget(\"Tags\", \"tags\", stringWidget(\"Tag\", \"value\")))\n * ```\n *\n * @see optional\n * @link https://decapcms.org/docs/widgets/#list\n */\nexport function listWidget<T extends string, F extends CmsField>(\n\tlabel: string,\n\tname: T,\n\tfields: F,\n\toptions?: WidgetOpts<CmsFieldList>,\n): { label: string; name: T; widget: 'list'; field: F };\nexport function listWidget<T extends string, F extends CmsField[]>(\n\tlabel: string,\n\tname: T,\n\tfields: F,\n\toptions?: WidgetOpts<CmsFieldList>,\n): { label: string; name: T; widget: 'list'; fields: F };\nexport function listWidget<T extends string, F extends CmsField | CmsField[]>(\n\tlabel: string,\n\tname: T,\n\tfields: F,\n\toptions?: WidgetOpts<CmsFieldList>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'list',\n\t\t...(options ?? {}),\n\t\t...(Array.isArray(fields)\n\t\t\t? { fields }\n\t\t\t: fields.widget === 'object'\n\t\t\t\t? { fields: (fields as CmsFieldObject).fields }\n\t\t\t\t: { field: fields }),\n\t} as const;\n}\n\n/**\n * Creates a Markdown widget configuration with the given label and name, and\n * optional additional options.\n *\n * **DecapCMS Configuration (TypeScript)**\n *\n * ```typescript\n * markdownWidget(\"Biography\", \"biography\")\n * ```\n *\n * **DecapCMS Configuration (YAML)**\n *\n * ```yaml\n * - label: Biography\n *   name: biography\n *   widget: richtext\n * ```\n *\n * **Data Store YAML**\n *\n * ```yaml\n * biography: |-\n *   Hello, world. I was born in the year 2000.\n * ```\n *\n * There are pre-configured constants available for use with the `options`\n * parameter:\n *\n * - INLINE_MARKDOWN\n * - RICH_MARKDOWN\n *\n * For example, to use the `RICH_MARKDOWN` configuration, you can do the following:\n *\n * ```typescript\n * markdownWidget(\"Biography\", \"biography\", RICH_MARKDOWN)\n * ```\n *\n * @see INLINE_MARKDOWN\n * @see RICH_MARKDOWN\n *\n * @link https://decapcms.org/docs/widgets/#Richtext%20(Beta)\n */\nexport function markdownWidget<T extends string>(\n\tlabel: string,\n\tname: T,\n\toptions?: WidgetOpts<CmsFieldMarkdown>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'richtext' as 'string',\n\t\t...(options ?? {}),\n\t} as const satisfies CmsField;\n}\n\n/**\n * Creates an Object widget configuration with the given label, name, fields, and\n * optional additional options.\n *\n * The object widget groups multiple fields together as a nested object in the\n * data store. This is useful for creating structured data with related properties.\n *\n * **DecapCMS Configuration (TypeScript)**\n *\n * ```typescript\n * objectWidget(\"Author\", \"author\", [\n *   stringWidget(\"Name\", \"name\"),\n *   stringWidget(\"Email\", \"email\"),\n * ])\n * ```\n *\n * **DecapCMS Configuration (YAML)**\n *\n * ```yaml\n * - label: Author\n *   name: author\n *   widget: object\n *   fields:\n *     - label: Name\n *       name: name\n *       widget: string\n *     - label: Email\n *       name: email\n *       widget: string\n * ```\n *\n * **Data Store YAML**\n *\n * ```yaml\n * author:\n *   name: Jane Doe\n *   email: jane@example.com\n * ```\n *\n * Objects can be nested within lists or other objects to create complex data\n * structures. They can also be made optional using the `optional` modifier:\n *\n * ```typescript\n * optional(objectWidget(\"Metadata\", \"metadata\", [\n *   stringWidget(\"SEO Title\", \"seoTitle\"),\n *   textWidget(\"Description\", \"description\"),\n * ]))\n * ```\n *\n * @see optional\n * @link https://decapcms.org/docs/widgets/#object\n */\nexport function objectWidget<T extends string, F extends CmsField[]>(\n\tlabel: string,\n\tname: T,\n\tfields: F,\n\toptions?: WidgetOpts<CmsFieldObject>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'object',\n\t\t...(options ?? {}),\n\t\tfields,\n\t} as const satisfies CmsField;\n}\n\n/**\n * Creates a Number widget configuration with the given label and name, and\n * optional additional options.\n *\n * **DecapCMS Configuration (TypeScript)**\n *\n * ```typescript\n * numberWidget(\"Priority\", \"priority\")\n * ```\n *\n * **DecapCMS Configuration (YAML)**\n *\n * ```yaml\n * - label: Priority\n *   name: priority\n *   widget: number\n * ```\n *\n * **Data Store YAML**\n *\n * ```yaml\n * priority: 1\n * ```\n *\n * The number widget provides numeric input with optional min, max, and step\n * constraints. It can be made optional using the `optional` modifier:\n *\n * ```typescript\n * optional(numberWidget(\"Views\", \"views\"))\n * ```\n *\n * @see optional\n * @link https://decapcms.org/docs/widgets/#number\n */\nexport function numberWidget<T extends string>(\n\tlabel: string,\n\tname: T,\n\toptions?: WidgetOpts<CmsFieldNumber>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'number',\n\t\t...(options ?? {}),\n\t} as const satisfies CmsField;\n}\n\n/**\n * Creates a Select widget configuration with the given label, name, choices, and\n * optional additional options.\n *\n * The select widget creates a dropdown menu with predefined options. The `choices`\n * array becomes the available options in the YAML configuration.\n *\n * **DecapCMS Configuration (TypeScript)**\n *\n * ```typescript\n * selectWidget(\"Status\", \"status\", [\"draft\", \"published\", \"archived\"] as const)\n * ```\n *\n * **DecapCMS Configuration (YAML)**\n *\n * ```yaml\n * - label: Status\n *   name: status\n *   widget: select\n *   options:\n *     - draft\n *     - published\n *     - archived\n * ```\n *\n * **Data Store YAML**\n *\n * ```yaml\n * status: published\n * ```\n *\n * The select widget can be made optional using the `optional` modifier:\n *\n * ```typescript\n * optional(selectWidget(\"Category\", \"category\", [\"tech\", \"lifestyle\", \"business\"] as const))\n * ```\n *\n * @see optional\n * @link https://decapcms.org/docs/widgets/#select\n */\nexport function selectWidget<T extends string, O extends string[]>(\n\tlabel: string,\n\tname: T,\n\tchoices: O,\n\toptions?: WidgetOpts<CmsFieldSelect>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'select',\n\t\t...(options ?? {}),\n\t\toptions: choices ?? [],\n\t} as const satisfies CmsField;\n}\n\n/**\n * Creates a String widget configuration with the given label and name, and\n * optional additional options.\n *\n * The string widget provides a single-line text input field for short text content.\n * Unlike the text widget which provides multi-line input, the string widget is\n * designed for concise, single-line values.\n *\n * **DecapCMS Configuration (TypeScript)**\n *\n * ```typescript\n * stringWidget(\"Title\", \"title\")\n * ```\n *\n * **DecapCMS Configuration (YAML)**\n *\n * ```yaml\n * - label: Title\n *   name: title\n *   widget: string\n * ```\n *\n * **Data Store YAML**\n *\n * ```yaml\n * title: Welcome to My Blog\n * ```\n *\n * The string widget can be made optional using the `optional` modifier:\n *\n * ```typescript\n * optional(stringWidget(\"Slug\", \"slug\"))\n * ```\n *\n * @see optional\n * @see textWidget\n * @link https://decapcms.org/docs/widgets/#string\n */\nexport function stringWidget<T extends string>(\n\tlabel: string,\n\tname: T,\n\toptions?: WidgetOpts<CmsFieldStringOrText>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'string',\n\t\t...(options ?? {}),\n\t} as const satisfies CmsField;\n}\n\n/**\n * Creates a Text widget configuration with the given label and name, and\n * optional additional options.\n *\n * The text widget provides a multi-line text input field for longer text content.\n * Unlike the string widget which provides single-line input, the text widget is\n * designed for paragraphs and multi-line content.\n *\n * **DecapCMS Configuration (TypeScript)**\n *\n * ```typescript\n * textWidget(\"Description\", \"description\")\n * ```\n *\n * **DecapCMS Configuration (YAML)**\n *\n * ```yaml\n * - label: Description\n *   name: description\n *   widget: text\n * ```\n *\n * **Data Store YAML**\n *\n * ```yaml\n * description: |-\n *   This is a longer description that spans\n *   multiple lines in the data store.\n * ```\n *\n * The text widget can be made optional using the `optional` modifier:\n *\n * ```typescript\n * optional(textWidget(\"Notes\", \"notes\"))\n * ```\n *\n * @see optional\n * @see stringWidget\n * @see markdownWidget\n * @link https://decapcms.org/docs/widgets/#text\n */\nexport function textWidget<T extends string>(\n\tlabel: string,\n\tname: T,\n\toptions?: WidgetOpts<CmsFieldStringOrText>,\n) {\n\treturn {\n\t\tlabel,\n\t\tname,\n\t\twidget: 'text',\n\t\t...(options ?? {}),\n\t} as const satisfies CmsField;\n}\n\n// Reusable Widget Configurations\n\n/**\n * Stripped down Markdown widget configuration that does the following:\n *\n * - Allows bold, italic, lists (bullet + numbered), quotes\n * - No images or code block components\n * - Rich Text preview only\n */\nexport const RICH_MARKDOWN: WidgetOpts<CmsFieldMarkdown> = {\n\tbuttons: [\n\t\t'bold',\n\t\t'bulleted-list',\n\t\t'italic',\n\t\t'link',\n\t\t'numbered-list',\n\t\t'quote',\n\t],\n\teditor_components: [],\n\tmodes: ['rich_text'],\n};\n\n/**\n * Stripped down Markdown Widget configuration that allows only inline\n * elements (e.g., no lists, quotes, or headings) and rich text preview only.\n */\nexport const INLINE_MARKDOWN: WidgetOpts<CmsFieldMarkdown> = {\n\tbuttons: ['bold', 'italic', 'link'],\n\teditor_components: [],\n\tmodes: ['rich_text'],\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkDA,SAAgB,SAA6B,QAA8B;CAC1E,OAAO;EACN,GAAG;EACH,UAAU;EACV,YAAY;CACb;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCA,SAAgB,WACf,OACA,MACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;CACjB;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCA,SAAgB,YACf,OACA,MACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;CACjB;AACD;AA2FA,SAAgB,WACf,OACA,MACA,QACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;EAChB,GAAI,MAAM,QAAQ,MAAM,IACrB,EAAE,OAAO,IACT,OAAO,WAAW,WACjB,EAAE,QAAS,OAA0B,OAAO,IAC5C,EAAE,OAAO,OAAO;CACrB;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CA,SAAgB,eACf,OACA,MACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;CACjB;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsDA,SAAgB,aACf,OACA,MACA,QACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;EAChB;CACD;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCA,SAAgB,aACf,OACA,MACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;CACjB;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,SAAgB,aACf,OACA,MACA,SACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;EAChB,SAAS,WAAW,CAAC;CACtB;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,SAAgB,aACf,OACA,MACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;CACjB;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,SAAgB,WACf,OACA,MACA,SACC;CACD,OAAO;EACN;EACA;EACA,QAAQ;EACR,GAAI,WAAW,CAAC;CACjB;AACD;;;;;;;;AAWA,MAAa,gBAA8C;CAC1D,SAAS;EACR;EACA;EACA;EACA;EACA;EACA;CACD;CACA,mBAAmB,CAAC;CACpB,OAAO,CAAC,WAAW;AACpB;;;;;AAMA,MAAa,kBAAgD;CAC5D,SAAS;EAAC;EAAQ;EAAU;CAAM;CAClC,mBAAmB,CAAC;CACpB,OAAO,CAAC,WAAW;AACpB"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@allejo/decap-extras",
-	"version": "0.0.6",
+	"version": "0.0.8",
 	"description": "A TypeScript utility library for Decap CMS with utility types to derive types from Decap CMS configuration files.",
 	"keywords": [
 		"decapcms"