mirror of
https://github.com/outline/outline.git
synced 2026-11-22 05:51:43 +03:00
119 lines
3.2 KiB
TypeScript
119 lines
3.2 KiB
TypeScript
import z from "zod";
|
|
import { DataAttributeDataType } from "@shared/models/types";
|
|
import { zodIconType } from "@server/utils/zod";
|
|
import { BaseSchema } from "../schema";
|
|
|
|
const BaseIdSchema = z.object({
|
|
/** Id of the data attribute */
|
|
id: z.string().uuid(),
|
|
});
|
|
|
|
const DataAttributesSortParamsSchema = z.object({
|
|
/** Specifies the attributes by which data attributes will be sorted in the list */
|
|
sort: z
|
|
.string()
|
|
.refine((val) => ["createdAt", "updatedAt"].includes(val))
|
|
.default("createdAt"),
|
|
|
|
/** Specifies the sort order with respect to sort field */
|
|
direction: z
|
|
.string()
|
|
.optional()
|
|
.transform((val) => (val !== "ASC" ? "DESC" : val)),
|
|
});
|
|
|
|
export const DataAttributesInfoSchema = BaseSchema.extend({
|
|
body: BaseIdSchema,
|
|
});
|
|
|
|
export type DataAttributesInfoReq = z.infer<typeof DataAttributesInfoSchema>;
|
|
|
|
export const DataAttributesListSchema = BaseSchema.extend({
|
|
body: DataAttributesSortParamsSchema,
|
|
});
|
|
|
|
export type DataAttributesListReq = z.infer<typeof DataAttributesListSchema>;
|
|
|
|
export const DataAttributesCreateSchema = BaseSchema.extend({
|
|
body: z
|
|
.object({
|
|
/** Name of the data attribute */
|
|
name: z.string(),
|
|
|
|
/** Description of the data attribute */
|
|
description: z.string().optional(),
|
|
|
|
/** Type of the data attribute */
|
|
dataType: z.nativeEnum(DataAttributeDataType),
|
|
|
|
/** Additional options for the data attribute */
|
|
options: z
|
|
.object({
|
|
/** An icon representing the data attribute */
|
|
icon: zodIconType().optional(),
|
|
options: z.array(
|
|
z.object({
|
|
/** Label of the option */
|
|
value: z.string(),
|
|
/** Color of the option */
|
|
color: z.string().optional(),
|
|
})
|
|
),
|
|
})
|
|
.optional(),
|
|
|
|
/** Whether the data attribute is pinned to the top of document */
|
|
pinned: z.boolean().optional(),
|
|
})
|
|
.refine(
|
|
(val) =>
|
|
val.dataType !== DataAttributeDataType.List ||
|
|
(val.dataType === DataAttributeDataType.List && val.options)
|
|
),
|
|
});
|
|
|
|
export type DataAttributesCreateReq = z.infer<
|
|
typeof DataAttributesCreateSchema
|
|
>;
|
|
|
|
export const DataAttributesUpdateSchema = BaseSchema.extend({
|
|
body: BaseIdSchema.extend({
|
|
/** Name of the data attribute */
|
|
name: z.string(),
|
|
|
|
/** Description of the data attribute */
|
|
description: z.string().optional(),
|
|
|
|
/** Additional options for the data attribute */
|
|
options: z
|
|
.object({
|
|
/** An icon representing the data attribute */
|
|
icon: zodIconType().nullish(),
|
|
options: z.array(
|
|
z.object({
|
|
/** Label of the option */
|
|
value: z.string(),
|
|
/** Color of the option */
|
|
color: z.string().optional(),
|
|
})
|
|
),
|
|
})
|
|
.optional(),
|
|
|
|
/** Whether the data attribute is pinned to the top of document */
|
|
pinned: z.boolean().optional(),
|
|
}),
|
|
});
|
|
|
|
export type DataAttributesUpdateReq = z.infer<
|
|
typeof DataAttributesUpdateSchema
|
|
>;
|
|
|
|
export const DataAttributesDeleteSchema = BaseSchema.extend({
|
|
body: BaseIdSchema,
|
|
});
|
|
|
|
export type DataAttributesDeleteReq = z.infer<
|
|
typeof DataAttributesDeleteSchema
|
|
>;
|