lokalise-mcp/dist/domains/usergroups/usergroups.types.js

The Lokalise MCP Server brings Lokalise's localization power to Claude and AI assistants—manage projects, keys, and translations by chat.

import { z } from "zod";
/**
 * Zod schema for contributor rights
 */
export const ContributorRightsSchema = z.enum([
    "upload",
    "activity",
    "download",
    "settings",
    "create_branches",
    "statistics",
    "keys",
    "screenshots",
    "glossary",
    "contributors",
    "languages",
    "tasks",
]);
/**
 * Zod schema for language permissions
 */
export const LanguagePermissionSchema = z.object({
    langId: z.number().describe("Language ID"),
    langIso: z.string().describe("Language ISO code"),
    langName: z.string().describe("Language name"),
    isWritable: z.boolean().describe("Whether the language is writable"),
});
/**
 * Zod schema for the list user groups tool arguments.
 */
export const ListUsergroupsToolArgs = z
    .object({
    teamId: z.string().describe("Team ID to list user groups for"),
    limit: z
        .number()
        .int()
        .min(1)
        .max(100)
        .optional()
        .describe("Number of user groups to return (1-100, default: 100)"),
    page: z
        .number()
        .int()
        .positive()
        .optional()
        .describe("Page number for pagination (default: 1)"),
})
    .strict();
/**
 * Zod schema for the get user group details tool arguments.
 */
export const GetUsergroupsToolArgs = z
    .object({
    teamId: z.string().describe("Team ID containing the user group"),
    groupId: z
        .union([z.string(), z.number()])
        .describe("User group ID to get details for"),
})
    .strict();
/**
 * Zod schema for the create user group tool arguments.
 */
export const CreateUsergroupsToolArgs = z
    .object({
    teamId: z.string().describe("Team ID to create user group in"),
    name: z.string().describe("Name of the user group"),
    isReviewer: z.boolean().describe("Whether group members are reviewers"),
    isAdmin: z.boolean().describe("Whether group members are admins"),
    adminRights: z
        .array(ContributorRightsSchema)
        .optional()
        .describe("Admin rights for the group if isAdmin is true"),
    languages: z
        .array(z.object({
        langId: z.number().describe("Language ID"),
        isWritable: z
            .boolean()
            .optional()
            .describe("Whether language is writable"),
    }))
        .optional()
        .describe("Language permissions for the group"),
    projects: z
        .array(z.union([z.string(), z.number()]))
        .optional()
        .describe("Initial projects to assign to the group"),
    members: z
        .array(z.union([z.string(), z.number()]))
        .optional()
        .describe("Initial members to add to the group"),
})
    .strict();
/**
 * Zod schema for the update user group tool arguments.
 */
export const UpdateUsergroupsToolArgs = z
    .object({
    teamId: z.string().describe("Team ID containing the user group"),
    groupId: z
        .union([z.string(), z.number()])
        .describe("User group ID to update"),
    name: z.string().describe("New name for the group"),
    isReviewer: z.boolean().describe("Whether group members are reviewers"),
    isAdmin: z.boolean().describe("Whether group members are admins"),
    adminRights: z
        .array(ContributorRightsSchema)
        .optional()
        .describe("Admin rights for the group if isAdmin is true"),
    languages: z
        .array(z.object({
        langId: z.number().describe("Language ID"),
        isWritable: z
            .boolean()
            .optional()
            .describe("Whether language is writable"),
    }))
        .optional()
        .describe("Language permissions for the group"),
})
    .strict();
/**
 * Zod schema for the delete user group tool arguments.
 */
export const DeleteUsergroupsToolArgs = z
    .object({
    teamId: z.string().describe("Team ID containing the user group"),
    groupId: z
        .union([z.string(), z.number()])
        .describe("User group ID to delete"),
})
    .strict();
/**
 * Zod schema for add members to group tool arguments.
 */
export const AddMembersToolArgs = z
    .object({
    teamId: z.string().describe("Team ID containing the user group"),
    groupId: z.union([z.string(), z.number()]).describe("User group ID"),
    userIds: z
        .array(z.union([z.string(), z.number()]))
        .min(1)
        .describe("User IDs to add to the group"),
})
    .strict();
/**
 * Zod schema for remove members from group tool arguments.
 */
export const RemoveMembersToolArgs = z
    .object({
    teamId: z.string().describe("Team ID containing the user group"),
    groupId: z.union([z.string(), z.number()]).describe("User group ID"),
    userIds: z
        .array(z.union([z.string(), z.number()]))
        .min(1)
        .describe("User IDs to remove from the group"),
})
    .strict();
/**
 * Zod schema for add projects to group tool arguments.
 */
export const AddProjectsToolArgs = z
    .object({
    teamId: z.string().describe("Team ID containing the user group"),
    groupId: z.union([z.string(), z.number()]).describe("User group ID"),
    projectIds: z
        .array(z.union([z.string(), z.number()]))
        .min(1)
        .describe("Project IDs to add to the group"),
})
    .strict();
/**
 * Zod schema for remove projects from group tool arguments.
 */
export const RemoveProjectsToolArgs = z
    .object({
    teamId: z.string().describe("Team ID containing the user group"),
    groupId: z.union([z.string(), z.number()]).describe("User group ID"),
    projectIds: z
        .array(z.union([z.string(), z.number()]))
        .min(1)
        .describe("Project IDs to remove from the group"),
})
    .strict();