bigbuffet-rw/packages/pl-api/lib/entities/admin/account.ts
marcin mikołajczak bc65755862 pl-api: Update docs
Signed-off-by: marcin mikołajczak <git@mkljczk.pl>
2024-11-29 16:01:54 +01:00

79 lines
2.6 KiB
TypeScript

import * as v from 'valibot';
import { accountSchema } from '../account';
import { roleSchema } from '../role';
import { datetimeSchema, filteredArray } from '../utils';
import { adminIpSchema } from './ip';
/**
* @category Admin schemas
* @see {@link https://docs.joinmastodon.org/entities/Admin_Account/}
*/
const adminAccountSchema = v.pipe(
v.any(),
v.transform((account: any) => {
if (!account.account) {
/**
* Convert Pleroma account schema
* @see {@link https://docs.pleroma.social/backend/development/API/admin_api/#get-apiv1pleromaadminusers}
*/
return {
id: account.id,
account: null,
username: account.nickname,
domain: account.nickname.split('@')[1] || null,
created_at: account.created_at,
email: account.email,
invite_request: account.registration_reason,
role: account.roles?.is_admin
? v.parse(roleSchema, { name: 'Admin' })
: account.roles?.moderator
? v.parse(roleSchema, { name: 'Moderator ' }) :
null,
confirmed: account.is_confirmed,
approved: account.is_approved,
disabled: !account.is_active,
actor_type: account.actor_type,
display_name: account.display_name,
suggested: account.is_suggested,
};
}
return account;
}),
v.object({
id: v.string(),
username: v.string(),
domain: v.fallback(v.nullable(v.string()), null),
created_at: v.fallback(datetimeSchema, new Date().toISOString()),
email: v.fallback(v.nullable(v.string()), null),
ip: v.fallback(v.nullable(v.pipe(v.string(), v.ip())), null),
ips: filteredArray(adminIpSchema),
locale: v.fallback(v.nullable(v.string()), null),
invite_request: v.fallback(v.nullable(v.string()), null),
role: v.fallback(v.nullable(roleSchema), null),
confirmed: v.fallback(v.boolean(), false),
approved: v.fallback(v.boolean(), false),
disabled: v.fallback(v.boolean(), false),
silenced: v.fallback(v.boolean(), false),
suspended: v.fallback(v.boolean(), false),
account: v.fallback(v.nullable(accountSchema), null),
created_by_application_id: v.fallback(v.optional(v.string()), undefined),
invited_by_account_id: v.fallback(v.optional(v.string()), undefined),
actor_type: v.fallback(v.nullable(v.string()), null),
display_name: v.fallback(v.nullable(v.string()), null),
suggested: v.fallback(v.nullable(v.boolean()), null),
}),
);
/**
* @category Admin entity types
*/
type AdminAccount = v.InferOutput<typeof adminAccountSchema>;
export {
adminAccountSchema,
type AdminAccount,
};