@cloudcannon/configuration-types 0.0.37 → 0.0.38

package/src/markdown.ts

@@ -0,0 +1,97 @@
+import * as z from 'zod';
+
+export const AttributeListPositionSchema = z
+	.enum(['none', 'right', 'space right', 'below', 'newline below', 'right-of-prefix'])
+	.meta({
+		id: 'AttributeListPosition',
+		title: 'Attribute List Position',
+		description: 'Positioning options for Markdown attribute elements.',
+	});
+
+export const MarkdownAttributeElementOptionsSchema = z
+	.intersection(
+		z.object({
+			inline: AttributeListPositionSchema.optional(),
+			block: AttributeListPositionSchema.optional(),
+		}),
+		z.record(z.string(), AttributeListPositionSchema)
+	)
+	.meta({
+		title: 'Markdown Attribute Element Options',
+		description: 'Configuration for positioning Markdown attributes on different element types.',
+	});
+
+export const MarkdownSettingsSchema = z
+	.object({
+		engine: z.enum(['commonmark', 'kramdown']).default('commonmark').meta({
+			description: 'The flavor of Markdown to use to convert between HTML and Markdown.',
+		}),
+		options: z.object({
+			html: z.boolean().optional().meta({
+				description: 'Output HTML tags from source.',
+			}),
+			xhtml: z.boolean().optional().meta({
+				description: 'Use `/` to close single tags (e.g. `<br />`).',
+			}),
+			breaks: z.boolean().optional().meta({
+				description: 'Convert `\\n` in paragraphs into `<br>`.',
+			}),
+			linkify: z.boolean().optional().meta({
+				description: 'Autoconvert URL-like text to links.',
+			}),
+			typographer: z.boolean().optional().meta({
+				description: 'Enable some language-neutral replacement, as well as quotes beautification.',
+			}),
+			quotes: z.string().optional().meta({
+				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`).',
+			}),
+			spaced_lists: z.boolean().optional().meta({
+				description: 'Output lists with an extra space in Markdown.',
+			}),
+			sentence_per_line: z.boolean().optional().meta({
+				description: 'Add linebreaks between sentences in Markdown.',
+			}),
+			gfm: z.boolean().optional().meta({
+				description: 'Enable GFM mode.',
+			}),
+			code_block_fences: z.enum(['```', '~~~']).optional().meta({
+				description: 'Determines which style of code block fences to use.',
+			}),
+			treat_indentation_as_code: z.boolean().optional().meta({
+				description: 'Determines whether 4 spaces on indentation should be read as a code block.',
+			}),
+			escape_snippets_in_code_blocks: z.boolean().optional().meta({
+				description: 'Render snippets as plain text within code blocks.',
+			}),
+			table: z.boolean().optional().meta({
+				description: 'Output tables in Markdown format.',
+			}),
+			strikethrough: z.boolean().optional().meta({
+				description: 'Output strikes in wrapped in double tildes (e.g. `~~strike~~`).',
+			}),
+			subscript: z.boolean().optional().meta({
+				description: 'Output subscript in wrapped in tildes (e.g. `~sub~`).',
+			}),
+			superscript: z.boolean().optional().meta({
+				description: 'Output superscript in wrapped in carets (e.g. `^super^`).',
+			}),
+			heading_ids: z.boolean().optional().meta({
+				description: 'Generate IDs for headings.',
+			}),
+			attributes: z.boolean().optional().meta({
+				description: 'Save element attributes in Markdown format instead of converting to HTML.',
+			}),
+			attribute_elements: MarkdownAttributeElementOptionsSchema.optional().meta({
+				description: 'Define positioning behavior of Markdown attributes for different elements.',
+			}),
+		}),
+	})
+	.meta({
+		title: 'Markdown Settings',
+		description: 'Configuration for Markdown processing engines and formatting options.',
+	});
+
+export type AttributeListPosition = z.infer<typeof AttributeListPositionSchema>;
+export type MarkdownAttributeElementOptions = z.infer<typeof MarkdownAttributeElementOptionsSchema>;
+export type MarkdownSettings = z.infer<typeof MarkdownSettingsSchema>;

package/src/mimetype.ts

@@ -0,0 +1,445 @@
+import * as z from 'zod';
+
+export const MimeTypeSchema = z
+	.enum([
+		'x-world/x-3dmf',
+		'application/x-authorware-bin',
+		'application/x-authorware-map',
+		'application/x-authorware-seg',
+		'text/vnd.abc',
+		'video/animaflex',
+		'application/postscript',
+		'audio/aiff',
+		'audio/x-aiff',
+		'application/x-aim',
+		'text/x-audiosoft-intra',
+		'application/x-navi-animation',
+		'application/x-nokia-9000-communicator-add-on-software',
+		'application/mime',
+		'application/arj',
+		'image/x-jg',
+		'video/x-ms-asf',
+		'text/x-asm',
+		'text/asp',
+		'application/x-mplayer2',
+		'video/x-ms-asf-plugin',
+		'audio/basic',
+		'audio/x-au',
+		'application/x-troff-msvideo',
+		'video/avi',
+		'video/msvideo',
+		'video/x-msvideo',
+		'video/avs-video',
+		'application/x-bcpio',
+		'application/mac-binary',
+		'application/macbinary',
+		'application/x-binary',
+		'application/x-macbinary',
+		'image/bmp',
+		'image/x-windows-bmp',
+		'application/book',
+		'application/x-bsh',
+		'application/x-bzip',
+		'application/x-bzip2',
+		'text/plain',
+		'text/x-c',
+		'application/vnd.ms-pki.seccat',
+		'application/clariscad',
+		'application/x-cocoa',
+		'application/cdf',
+		'application/x-cdf',
+		'application/x-netcdf',
+		'application/pkix-cert',
+		'application/x-x509-ca-cert',
+		'application/x-chat',
+		'application/java',
+		'application/java-byte-code',
+		'application/x-java-class',
+		'application/x-cpio',
+		'application/mac-compactpro',
+		'application/x-compactpro',
+		'application/x-cpt',
+		'application/pkcs-crl',
+		'application/pkix-crl',
+		'application/x-x509-user-cert',
+		'application/x-csh',
+		'text/x-script.csh',
+		'application/x-pointplus',
+		'text/css',
+		'text/csv',
+		'application/x-director',
+		'application/x-deepv',
+		'video/x-dv',
+		'video/dl',
+		'video/x-dl',
+		'application/msword',
+		'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+		'application/commonground',
+		'application/drafting',
+		'application/x-dvi',
+		'drawing/x-dwf (old)',
+		'model/vnd.dwf',
+		'application/acad',
+		'image/vnd.dwg',
+		'image/x-dwg',
+		'application/dxf',
+		'text/x-script.elisp',
+		'application/x-bytecode.elisp (compiled elisp)',
+		'application/x-elc',
+		'application/x-envoy',
+		'application/x-esrehber',
+		'text/x-setext',
+		'application/envoy',
+		'text/x-fortran',
+		'application/vnd.fdf',
+		'application/fractals',
+		'image/fif',
+		'video/fli',
+		'video/x-fli',
+		'image/florian',
+		'text/vnd.fmi.flexstor',
+		'video/x-atomic3d-feature',
+		'image/vnd.fpx',
+		'image/vnd.net-fpx',
+		'application/freeloader',
+		'audio/make',
+		'image/g3fax',
+		'image/gif',
+		'video/gl',
+		'video/x-gl',
+		'audio/x-gsm',
+		'application/x-gsp',
+		'application/x-gss',
+		'application/x-gtar',
+		'application/x-compressed',
+		'application/x-gzip',
+		'multipart/x-gzip',
+		'text/x-h',
+		'application/x-hdf',
+		'application/x-helpfile',
+		'application/vnd.hp-hpgl',
+		'text/x-script',
+		'application/hlp',
+		'application/x-winhelp',
+		'application/binhex',
+		'application/binhex4',
+		'application/mac-binhex',
+		'application/mac-binhex40',
+		'application/x-binhex40',
+		'application/x-mac-binhex40',
+		'application/hta',
+		'text/x-component',
+		'text/html',
+		'text/webviewhtml',
+		'x-conference/x-cooltalk',
+		'image/x-icon',
+		'image/ief',
+		'application/iges',
+		'model/iges',
+		'application/x-ima',
+		'application/x-httpd-imap',
+		'application/inf',
+		'application/x-internett-signup',
+		'application/x-ip2',
+		'video/x-isvideo',
+		'audio/it',
+		'application/x-inventor',
+		'i-world/i-vrml',
+		'application/x-livescreen',
+		'audio/x-jam',
+		'text/x-java-source',
+		'application/x-java-commerce',
+		'image/jpeg',
+		'image/pjpeg',
+		'image/x-jps',
+		'application/x-javascript',
+		'application/javascript',
+		'application/ecmascript',
+		'text/javascript',
+		'text/ecmascript',
+		'application/json',
+		'image/jutvision',
+		'music/x-karaoke',
+		'application/x-ksh',
+		'text/x-script.ksh',
+		'audio/nspaudio',
+		'audio/x-nspaudio',
+		'audio/x-liveaudio',
+		'application/x-latex',
+		'application/lha',
+		'application/x-lha',
+		'application/x-lisp',
+		'text/x-script.lisp',
+		'text/x-la-asf',
+		'application/x-lzh',
+		'application/lzx',
+		'application/x-lzx',
+		'text/x-m',
+		'audio/mpeg',
+		'audio/x-mpequrl',
+		'audio/m4a',
+		'audio/x-m4a',
+		'application/x-troff-man',
+		'application/x-navimap',
+		'application/mbedlet',
+		'application/x-magic-cap-package-1.0',
+		'application/mcad',
+		'application/x-mathcad',
+		'image/vasa',
+		'text/mcf',
+		'application/netmc',
+		'text/markdown',
+		'application/x-troff-me',
+		'message/rfc822',
+		'application/x-midi',
+		'audio/midi',
+		'audio/x-mid',
+		'audio/x-midi',
+		'music/crescendo',
+		'x-music/x-midi',
+		'application/x-frame',
+		'application/x-mif',
+		'www/mime',
+		'audio/x-vnd.audioexplosion.mjuicemediafile',
+		'video/x-motion-jpeg',
+		'application/base64',
+		'application/x-meme',
+		'audio/mod',
+		'audio/x-mod',
+		'video/quicktime',
+		'video/x-sgi-movie',
+		'audio/x-mpeg',
+		'video/x-mpeg',
+		'video/x-mpeq2a',
+		'audio/mpeg3',
+		'audio/x-mpeg-3',
+		'video/mp4',
+		'application/x-project',
+		'video/mpeg',
+		'application/vnd.ms-project',
+		'application/marc',
+		'application/x-troff-ms',
+		'application/x-vnd.audioexplosion.mzz',
+		'image/naplps',
+		'application/vnd.nokia.configuration-message',
+		'image/x-niff',
+		'application/x-mix-transfer',
+		'application/x-conference',
+		'application/x-navidoc',
+		'application/octet-stream',
+		'application/oda',
+		'audio/ogg',
+		'application/ogg',
+		'video/ogg',
+		'application/x-omc',
+		'application/x-omcdatamaker',
+		'application/x-omcregerator',
+		'text/x-pascal',
+		'application/pkcs10',
+		'application/x-pkcs10',
+		'application/pkcs-12',
+		'application/x-pkcs12',
+		'application/x-pkcs7-signature',
+		'application/pkcs7-mime',
+		'application/x-pkcs7-mime',
+		'application/x-pkcs7-certreqresp',
+		'application/pkcs7-signature',
+		'application/pro_eng',
+		'text/pascal',
+		'image/x-portable-bitmap',
+		'application/vnd.hp-pcl',
+		'application/x-pcl',
+		'image/x-pict',
+		'image/x-pcx',
+		'chemical/x-pdb',
+		'application/pdf',
+		'audio/make.my.funk',
+		'image/x-portable-graymap',
+		'image/x-portable-greymap',
+		'image/pict',
+		'application/x-newton-compatible-pkg',
+		'application/vnd.ms-pki.pko',
+		'text/x-script.perl',
+		'application/x-pixclscript',
+		'image/x-xpixmap',
+		'text/x-script.perl-module',
+		'application/x-pagemaker',
+		'image/png',
+		'application/x-portable-anymap',
+		'image/x-portable-anymap',
+		'model/x-pov',
+		'image/x-portable-pixmap',
+		'application/mspowerpoint',
+		'application/powerpoint',
+		'application/vnd.ms-powerpoint',
+		'application/x-mspowerpoint',
+		'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+		'application/x-freelance',
+		'paleovu/x-pv',
+		'text/x-script.phyton',
+		'application/x-bytecode.python',
+		'audio/vnd.qcelp',
+		'image/x-quicktime',
+		'video/x-qtc',
+		'audio/x-pn-realaudio',
+		'audio/x-pn-realaudio-plugin',
+		'audio/x-realaudio',
+		'application/x-cmu-raster',
+		'image/cmu-raster',
+		'image/x-cmu-raster',
+		'text/x-script.rexx',
+		'image/vnd.rn-realflash',
+		'image/x-rgb',
+		'application/vnd.rn-realmedia',
+		'audio/mid',
+		'application/ringing-tones',
+		'application/vnd.nokia.ringing-tone',
+		'application/vnd.rn-realplayer',
+		'application/x-troff',
+		'image/vnd.rn-realpix',
+		'application/x-rtf',
+		'text/richtext',
+		'application/rtf',
+		'video/vnd.rn-realvideo',
+		'audio/s3m',
+		'application/x-tbook',
+		'application/x-lotusscreencam',
+		'text/x-script.guile',
+		'text/x-script.scheme',
+		'video/x-scm',
+		'application/sdp',
+		'application/x-sdp',
+		'application/sounder',
+		'application/sea',
+		'application/x-sea',
+		'application/set',
+		'text/sgml',
+		'text/x-sgml',
+		'application/x-sh',
+		'application/x-shar',
+		'text/x-script.sh',
+		'text/x-server-parsed-html',
+		'audio/x-psid',
+		'application/x-sit',
+		'application/x-stuffit',
+		'application/x-koan',
+		'application/x-seelogo',
+		'application/smil',
+		'audio/x-adpcm',
+		'application/solids',
+		'application/x-pkcs7-certificates',
+		'text/x-speech',
+		'application/futuresplash',
+		'application/x-sprite',
+		'application/x-wais-source',
+		'application/streamingmedia',
+		'application/vnd.ms-pki.certstore',
+		'application/step',
+		'application/sla',
+		'application/vnd.ms-pki.stl',
+		'application/x-navistyle',
+		'application/x-sv4cpio',
+		'application/x-sv4crc',
+		'image/svg+xml',
+		'application/x-world',
+		'x-world/x-svr',
+		'application/x-shockwave-flash',
+		'application/x-tar',
+		'application/toolbook',
+		'application/x-tcl',
+		'text/x-script.tcl',
+		'text/x-script.tcsh',
+		'application/x-tex',
+		'application/x-texinfo',
+		'application/plain',
+		'application/gnutar',
+		'image/tiff',
+		'image/x-tiff',
+		'application/toml',
+		'audio/tsp-audio',
+		'application/dsptype',
+		'audio/tsplayer',
+		'text/tab-separated-values',
+		'application/i-deas',
+		'text/uri-list',
+		'application/x-ustar',
+		'multipart/x-ustar',
+		'text/x-uuencode',
+		'application/x-cdlink',
+		'text/x-vcalendar',
+		'application/vda',
+		'video/vdo',
+		'application/groupwise',
+		'video/vivo',
+		'video/vnd.vivo',
+		'application/vocaltec-media-desc',
+		'application/vocaltec-media-file',
+		'audio/voc',
+		'audio/x-voc',
+		'video/vosaic',
+		'audio/voxware',
+		'audio/x-twinvq-plugin',
+		'audio/x-twinvq',
+		'application/x-vrml',
+		'model/vrml',
+		'x-world/x-vrml',
+		'x-world/x-vrt',
+		'application/x-visio',
+		'application/wordperfect6.0',
+		'application/wordperfect6.1',
+		'audio/wav',
+		'audio/x-wav',
+		'application/x-qpro',
+		'image/vnd.wap.wbmp',
+		'application/vnd.xara',
+		'video/webm',
+		'audio/webm',
+		'image/webp',
+		'application/x-123',
+		'windows/metafile',
+		'text/vnd.wap.wml',
+		'application/vnd.wap.wmlc',
+		'text/vnd.wap.wmlscript',
+		'application/vnd.wap.wmlscriptc',
+		'video/x-ms-wmv',
+		'application/wordperfect',
+		'application/x-wpwin',
+		'application/x-lotus',
+		'application/mswrite',
+		'application/x-wri',
+		'text/scriplet',
+		'application/x-wintalk',
+		'image/x-xbitmap',
+		'image/x-xbm',
+		'image/xbm',
+		'video/x-amt-demorun',
+		'xgl/drawing',
+		'image/vnd.xiff',
+		'application/excel',
+		'application/vnd.ms-excel',
+		'application/x-excel',
+		'application/x-msexcel',
+		'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+		'audio/xm',
+		'application/xml',
+		'text/xml',
+		'xgl/movie',
+		'application/x-vnd.ls-xpix',
+		'image/xpm',
+		'video/x-amt-showrun',
+		'image/x-xwd',
+		'image/x-xwindowdump',
+		'text/vnd.yaml',
+		'application/x-compress',
+		'application/x-zip-compressed',
+		'application/zip',
+		'multipart/x-zip',
+		'text/x-script.zsh',
+	])
+	.meta({
+		id: 'MimeType',
+		title: 'Mime Type',
+		description: 'MIME type identifiers for file type validation and handling in CloudCannon.',
+	});
+
+export type MimeType = z.infer<typeof MimeTypeSchema>;

package/src/paths.ts

@@ -0,0 +1,43 @@
+import * as z from 'zod';
+
+export const PathsSchema = z
+	.object({
+		static: z.string().optional().meta({
+			id: 'Paths.static',
+			description:
+				'Location of assets that are statically copied to the output site. This prefix will be removed from the _Uploads_ path when CloudCannon outputs the URL of an asset.',
+		}),
+		uploads: z.string().default('uploads').optional().meta({
+			id: 'Paths.uploads',
+			description: 'Default location of newly uploaded site files.',
+		}),
+		uploads_filename: z.string().optional().meta({
+			id: 'Paths.uploads_filename',
+			description: 'Filename template for newly uploaded site files.',
+		}),
+		dam_uploads: z.string().optional().meta({
+			id: 'Paths.dam_uploads',
+			description: 'Default location of newly uploaded DAM files.',
+		}),
+		dam_uploads_filename: z.string().optional().meta({
+			id: 'Paths.dam_uploads_filename',
+			description: 'Filename template for newly uploaded DAM files.',
+		}),
+		dam_static: z.string().optional().meta({
+			id: 'Paths.dam_static',
+			description:
+				'Location of statically copied assets for DAM files. This prefix will be removed from the _DAM Uploads_ path when CloudCannon outputs the URL of an asset.',
+		}),
+		uploads_use_relative_path: z.boolean().optional().meta({
+			id: 'Paths.uploads_use_relative_path',
+			description:
+				'When set to true, CloudCannon will reference files relative to the path of the file they were uploaded to.',
+		}),
+	})
+	.meta({
+		id: 'paths',
+		description:
+			'Paths to where new asset files are uploaded to. They also set the default path when choosing existing images, and linking to existing files. Each path is relative to global `source`. Defaults to the global `paths`.',
+	});
+
+export type Paths = z.infer<typeof PathsSchema>;