Files
outline/server/routes/api/groups/schema.ts
Tom Moor 1a893b0e45 Group sync framework (#11684)
Adds group sync from external authentication providers, allowing team group memberships to be automatically managed based on provider data on sign-in in the future.
2026-03-14 23:02:20 -04:00

150 lines
4.1 KiB
TypeScript

import { z } from "zod";
import { GroupPermission } from "@shared/types";
import { GroupValidation } from "@shared/validations";
import { Group } from "@server/models";
const BaseIdSchema = z.object({
/** Group Id */
id: z.uuid(),
});
export const GroupsListSchema = z.object({
body: z.object({
/** Groups sorting direction */
direction: z
.string()
.optional()
.transform((val) => (val !== "ASC" ? "DESC" : val)),
/** Groups sorting column */
sort: z
.string()
.refine(
(val) =>
Object.keys(Group.getAttributes()).includes(val) || val === "source",
{
error: "Invalid sort parameter",
}
)
.prefault("updatedAt"),
/** Only list groups where this user is a member */
userId: z.uuid().optional(),
/** Find group matching externalId */
externalId: z.string().optional(),
/** @deprecated Find group with matching name */
name: z.string().optional(),
/** Filter groups by source: "manual" for non-synced, or a provider name */
source: z.string().optional(),
/** Find group matching query */
query: z.string().optional(),
}),
});
export type GroupsListReq = z.infer<typeof GroupsListSchema>;
export const GroupsInfoSchema = z.object({
body: z.object({
/** Group Id */
id: z.uuid().optional(),
/** External source. */
externalId: z.string().optional(),
}),
});
export type GroupsInfoReq = z.infer<typeof GroupsInfoSchema>;
export const GroupsCreateSchema = z.object({
body: z.object({
/** Group name */
name: z.string(),
/** Group description */
description: z
.string()
.max(GroupValidation.maxDescriptionLength)
.optional(),
/** Optionally link this group to an external source. */
externalId: z.string().optional(),
/** Whether mentions are disabled for this group */
disableMentions: z.boolean().optional().prefault(false),
}),
});
export type GroupsCreateReq = z.infer<typeof GroupsCreateSchema>;
export const GroupsUpdateSchema = z.object({
body: BaseIdSchema.extend({
/** Group name */
name: z.string().optional(),
/** Group description */
description: z
.string()
.max(GroupValidation.maxDescriptionLength)
.optional(),
/** Optionally link this group to an external source. */
externalId: z.string().optional(),
/** Whether mentions are disabled for this group */
disableMentions: z.boolean().optional(),
}),
});
export type GroupsUpdateReq = z.infer<typeof GroupsUpdateSchema>;
export const GroupsDeleteSchema = z.object({
body: BaseIdSchema,
});
export type GroupsDeleteReq = z.infer<typeof GroupsDeleteSchema>;
export const GroupsDeleteAllSchema = z.object({
body: z.object({
/** The authentication provider whose synced groups should be deleted. */
authenticationProviderId: z.uuid(),
}),
});
export type GroupsDeleteAllReq = z.infer<typeof GroupsDeleteAllSchema>;
export const GroupsMembershipsSchema = z.object({
body: BaseIdSchema.extend({
/** Group name search query */
query: z.string().optional(),
/** Filter by group permission */
permission: z.nativeEnum(GroupPermission).optional(),
}),
});
export type GroupsMembershipsReq = z.infer<typeof GroupsMembershipsSchema>;
export const GroupsAddUserSchema = z.object({
body: BaseIdSchema.extend({
/** User Id */
userId: z.uuid(),
/** The permission of the user in the group */
permission: z
.enum(GroupPermission)
.optional()
.prefault(GroupPermission.Member),
}),
});
export type GroupsAddUserReq = z.infer<typeof GroupsAddUserSchema>;
export const GroupsRemoveUserSchema = z.object({
body: BaseIdSchema.extend({
/** User Id */
userId: z.uuid(),
}),
});
export type GroupsRemoveUserReq = z.infer<typeof GroupsRemoveUserSchema>;
export const GroupsUpdateUserSchema = z.object({
body: BaseIdSchema.extend({
/** User Id */
userId: z.uuid(),
/** The permission of the user in the group */
permission: z.enum(GroupPermission),
}),
});
export type GroupsUpdateUserReq = z.infer<typeof GroupsUpdateUserSchema>;