@cloudcannon/configuration-types 0.0.37 → 0.0.38

package/src/image-options.ts

@@ -0,0 +1,72 @@
+import * as z from 'zod';
+
+export const ImageOptionsSchema = z.object({
+	mime_type: z.enum(['image/jpeg', 'image/png', 'image/webp']).optional().meta({
+		id: 'mime_type',
+		title: 'Mime Type',
+		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.',
+	}),
+	resize_style: z.enum(['cover', 'contain', 'stretch', 'crop']).default('contain').optional().meta({
+		id: 'resize_style',
+		title: 'Resize Style',
+		description:
+			'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.',
+	}),
+	width: z.number().optional().meta({
+		id: 'width',
+		title: 'Width',
+		description:
+			'Defines the width of the bounding box used in the image resizing process defined with resize_style.',
+	}),
+	height: z.number().optional().meta({
+		id: 'height',
+		title: 'Height',
+		description:
+			'Defines the height of the bounding box used in the image resizing process defined with resize_style.',
+	}),
+	expandable: z.boolean().default(false).optional().meta({
+		id: 'expandable',
+		title: 'Expandable',
+		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.',
+	}),
+	image_size_attributes: z.boolean().default(true).optional().meta({
+		id: 'image_size_attributes',
+		title: 'Image Size Attributes',
+		description:
+			'Instructs the editor to save `width` and `height` attributes on the image elements. This can prevent pop-in as a page loads.',
+	}),
+	allowed_sources: z.array(z.string()).optional().meta({
+		id: 'allowed_sources',
+		title: 'Allowed Sources',
+		description:
+			'If you have one or more DAMs connected to your site, you can use this key to list which asset sources can be uploaded to and selected from.',
+	}),
+	prevent_resize_existing_files: z.boolean().default(false).optional().meta({
+		id: 'prevent_resize_existing_files',
+		title: 'Prevent Resize Existing Files',
+		description:
+			'Enable to skip the image resizing process configured for this input when selecting existing images.',
+	}),
+	sizes: z
+		.array(
+			z.object({
+				size: z.string().meta({
+					description:
+						'A number suffixed with "x" (relative size) or "w" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).',
+				}),
+				target: z.string().optional().meta({
+					description:
+						'A reference to another input that is given the path to this additional image file.',
+				}),
+			})
+		)
+		.optional()
+		.meta({
+			id: 'sizes',
+			title: 'Sizes',
+			description:
+				'Definitions for creating additional images of different sizes when uploading or selecting existing files.',
+		}),
+});

package/src/index.ts

@@ -0,0 +1,40 @@
+import * as z from 'zod';
+
+export * from './build-coupled';
+export * from './cascade';
+export * from './configuration';
+export * from './documentation';
+export * from './editables';
+export * from './icon';
+export * from './image-options';
+export * from './inputs';
+export * from './markdown';
+export * from './paths';
+export * from './preview';
+export * from './select-values';
+export * from './snippets';
+export * from './source-editor';
+export * from './structures';
+export * from './timezone';
+
+export const SsgKeySchema = z.enum([
+	'hugo',
+	'jekyll',
+	'eleventy',
+	'astro',
+	'lume',
+	'mkdocs',
+	'nextjs',
+	'sveltekit',
+	'bridgetown',
+	'docusaurus',
+	'gatsby',
+	'hexo',
+	'nuxtjs',
+	'sphinx',
+	'static',
+	'legacy',
+	'other',
+]);
+
+export type SsgKey = z.infer<typeof SsgKeySchema>;