feat: add fluxer upstream source and self-hosting documentation
- Clone of github.com/fluxerapp/fluxer (official upstream) - SELF_HOSTING.md: full VM rebuild procedure, architecture overview, service reference, step-by-step setup, troubleshooting, seattle reference - dev/.env.example: all env vars with secrets redacted and generation instructions - dev/livekit.yaml: LiveKit config template with placeholder keys - fluxer-seattle/: existing seattle deployment setup scripts
This commit is contained in:
Vish
231
fluxer/packages/schema/src/domains/invite/InviteSchemas.tsx
Normal file
231
fluxer/packages/schema/src/domains/invite/InviteSchemas.tsx
Normal file
@@ -0,0 +1,231 @@
|
||||
/*
|
||||
* Copyright (C) 2026 Fluxer Contributors
|
||||
*
|
||||
* This file is part of Fluxer.
|
||||
*
|
||||
* Fluxer is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* Fluxer is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with Fluxer. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
import {InviteTypes} from '@fluxer/constants/src/ChannelConstants';
|
||||
import {MAX_INVITE_AGE_SECONDS, MAX_INVITE_USES} from '@fluxer/constants/src/LimitConstants';
|
||||
import {type Channel, ChannelPartialResponse} from '@fluxer/schema/src/domains/channel/ChannelSchemas';
|
||||
import {type Guild, GuildPartialResponse} from '@fluxer/schema/src/domains/guild/GuildResponseSchemas';
|
||||
import {PackType} from '@fluxer/schema/src/domains/pack/PackSchemas';
|
||||
import {UserPartialResponse} from '@fluxer/schema/src/domains/user/UserResponseSchemas';
|
||||
import {Int32Type, SnowflakeStringType} from '@fluxer/schema/src/primitives/SchemaPrimitives';
|
||||
import {z} from 'zod';
|
||||
|
||||
export const ChannelInviteCreateRequest = z.object({
|
||||
max_uses: z
|
||||
.number()
|
||||
.int()
|
||||
.min(0)
|
||||
.max(MAX_INVITE_USES)
|
||||
.nullish()
|
||||
.default(0)
|
||||
.describe('Maximum number of times this invite can be used (0 for unlimited)'),
|
||||
max_age: z
|
||||
.number()
|
||||
.int()
|
||||
.min(0)
|
||||
.max(MAX_INVITE_AGE_SECONDS)
|
||||
.nullish()
|
||||
.default(0)
|
||||
.describe('Duration in seconds before the invite expires (0 for never)'),
|
||||
unique: z
|
||||
.boolean()
|
||||
.nullish()
|
||||
.default(false)
|
||||
.describe('Whether to create a new unique invite or reuse an existing one'),
|
||||
temporary: z
|
||||
.boolean()
|
||||
.nullish()
|
||||
.default(false)
|
||||
.describe('Whether members that joined via this invite should be kicked after disconnecting'),
|
||||
});
|
||||
export type ChannelInviteCreateRequest = z.infer<typeof ChannelInviteCreateRequest>;
|
||||
|
||||
export const PackInviteCreateRequest = z.object({
|
||||
max_uses: z
|
||||
.number()
|
||||
.int()
|
||||
.min(0)
|
||||
.max(MAX_INVITE_USES)
|
||||
.nullish()
|
||||
.default(0)
|
||||
.describe('Maximum number of times this invite can be used (0 for unlimited)'),
|
||||
max_age: z
|
||||
.number()
|
||||
.int()
|
||||
.min(0)
|
||||
.max(MAX_INVITE_AGE_SECONDS)
|
||||
.nullish()
|
||||
.default(0)
|
||||
.describe('Duration in seconds before the invite expires (0 for never)'),
|
||||
unique: z
|
||||
.boolean()
|
||||
.nullish()
|
||||
.default(false)
|
||||
.describe('Whether to create a new unique invite or reuse an existing one'),
|
||||
});
|
||||
export type PackInviteCreateRequest = z.infer<typeof PackInviteCreateRequest>;
|
||||
|
||||
export const GuildInviteResponse = z.object({
|
||||
code: z.string().describe('The unique invite code'),
|
||||
type: z.literal(InviteTypes.GUILD).describe('The type of invite (guild)'),
|
||||
guild: GuildPartialResponse.describe('The guild this invite is for'),
|
||||
channel: z.lazy(() => ChannelPartialResponse).describe('The channel this invite is for'),
|
||||
inviter: z
|
||||
.lazy(() => UserPartialResponse)
|
||||
.nullish()
|
||||
.describe('The user who created the invite'),
|
||||
member_count: Int32Type.describe('The approximate total member count of the guild'),
|
||||
presence_count: Int32Type.describe('The approximate online member count of the guild'),
|
||||
expires_at: z.iso.datetime().nullish().describe('ISO8601 timestamp of when the invite expires'),
|
||||
temporary: z.boolean().describe('Whether the invite grants temporary membership'),
|
||||
});
|
||||
|
||||
export type GuildInviteResponse = z.infer<typeof GuildInviteResponse>;
|
||||
|
||||
export const GroupDmInviteResponse = z.object({
|
||||
code: z.string().describe('The unique invite code'),
|
||||
type: z.literal(InviteTypes.GROUP_DM).describe('The type of invite (group DM)'),
|
||||
channel: z.lazy(() => ChannelPartialResponse).describe('The group DM channel this invite is for'),
|
||||
inviter: z
|
||||
.lazy(() => UserPartialResponse)
|
||||
.nullish()
|
||||
.describe('The user who created the invite'),
|
||||
member_count: Int32Type.describe('The current member count of the group DM'),
|
||||
expires_at: z.iso.datetime().nullish().describe('ISO8601 timestamp of when the invite expires'),
|
||||
temporary: z.boolean().describe('Whether the invite grants temporary membership'),
|
||||
});
|
||||
|
||||
export type GroupDmInviteResponse = z.infer<typeof GroupDmInviteResponse>;
|
||||
|
||||
const PackInfoResponse = z.object({
|
||||
id: SnowflakeStringType.describe('The unique identifier for the pack'),
|
||||
name: z.string().describe('The display name of the pack'),
|
||||
description: z.string().nullish().describe('The description of the pack'),
|
||||
type: PackType.describe('The type of pack (emoji or sticker)'),
|
||||
creator_id: SnowflakeStringType.describe('The ID of the user who created the pack'),
|
||||
created_at: z.iso.datetime().describe('ISO8601 timestamp of when the pack was created'),
|
||||
updated_at: z.iso.datetime().describe('ISO8601 timestamp of when the pack was last updated'),
|
||||
creator: z.lazy(() => UserPartialResponse).describe('The user who created the pack'),
|
||||
});
|
||||
|
||||
export const PackInviteResponse = z.object({
|
||||
code: z.string().describe('The unique invite code'),
|
||||
type: z
|
||||
.union([z.literal(InviteTypes.EMOJI_PACK), z.literal(InviteTypes.STICKER_PACK)])
|
||||
.describe('The type of pack invite (emoji or sticker pack)'),
|
||||
pack: PackInfoResponse.describe('The pack this invite is for'),
|
||||
inviter: z
|
||||
.lazy(() => UserPartialResponse)
|
||||
.nullish()
|
||||
.describe('The user who created the invite'),
|
||||
expires_at: z.iso.datetime().nullish().describe('ISO8601 timestamp of when the invite expires'),
|
||||
temporary: z.boolean().describe('Whether the invite grants temporary access'),
|
||||
});
|
||||
|
||||
export type PackInviteResponse = z.infer<typeof PackInviteResponse>;
|
||||
|
||||
export const PackInviteMetadataResponse = z.object({
|
||||
...PackInviteResponse.shape,
|
||||
created_at: z.iso.datetime().describe('ISO8601 timestamp of when the invite was created'),
|
||||
uses: Int32Type.describe('The number of times this invite has been used'),
|
||||
max_uses: Int32Type.describe('The maximum number of times this invite can be used'),
|
||||
});
|
||||
|
||||
export type PackInviteMetadataResponse = z.infer<typeof PackInviteMetadataResponse>;
|
||||
|
||||
export const GuildInviteMetadataResponse = z.object({
|
||||
...GuildInviteResponse.shape,
|
||||
created_at: z.iso.datetime().describe('ISO8601 timestamp of when the invite was created'),
|
||||
uses: Int32Type.describe('The number of times this invite has been used'),
|
||||
max_uses: Int32Type.describe('The maximum number of times this invite can be used'),
|
||||
max_age: Int32Type.describe('The duration in seconds before the invite expires'),
|
||||
});
|
||||
|
||||
export type GuildInviteMetadataResponse = z.infer<typeof GuildInviteMetadataResponse>;
|
||||
|
||||
export const GroupDmInviteMetadataResponse = z.object({
|
||||
...GroupDmInviteResponse.shape,
|
||||
created_at: z.iso.datetime().describe('ISO8601 timestamp of when the invite was created'),
|
||||
uses: Int32Type.describe('The number of times this invite has been used'),
|
||||
max_uses: Int32Type.describe('The maximum number of times this invite can be used'),
|
||||
});
|
||||
|
||||
export type GroupDmInviteMetadataResponse = z.infer<typeof GroupDmInviteMetadataResponse>;
|
||||
|
||||
export const InviteResponseSchema = z.union([GuildInviteResponse, GroupDmInviteResponse, PackInviteResponse]);
|
||||
|
||||
export type InviteResponseSchema = z.infer<typeof InviteResponseSchema>;
|
||||
|
||||
export const InviteMetadataResponseSchema = z.union([
|
||||
GuildInviteMetadataResponse,
|
||||
GroupDmInviteMetadataResponse,
|
||||
PackInviteMetadataResponse,
|
||||
]);
|
||||
|
||||
export type InviteMetadataResponseSchema = z.infer<typeof InviteMetadataResponseSchema>;
|
||||
|
||||
export const InviteMetadataListResponse = z
|
||||
.array(InviteMetadataResponseSchema)
|
||||
.max(1000)
|
||||
.describe('A list of invite metadata');
|
||||
export type InviteMetadataListResponse = z.infer<typeof InviteMetadataListResponse>;
|
||||
|
||||
export interface InviteBase {
|
||||
readonly code: string;
|
||||
readonly type: number;
|
||||
readonly inviter?: UserPartialResponse | null;
|
||||
readonly expires_at: string | null;
|
||||
readonly temporary: boolean;
|
||||
}
|
||||
|
||||
export interface GuildInvite extends InviteBase {
|
||||
readonly type: typeof InviteTypes.GUILD;
|
||||
readonly guild: Guild;
|
||||
readonly channel: Channel;
|
||||
readonly member_count: number;
|
||||
readonly presence_count: number;
|
||||
readonly uses?: number;
|
||||
readonly max_uses?: number;
|
||||
readonly created_at?: string;
|
||||
}
|
||||
|
||||
export interface GroupDmInvite extends InviteBase {
|
||||
readonly type: typeof InviteTypes.GROUP_DM;
|
||||
readonly channel: Channel;
|
||||
readonly member_count: number;
|
||||
}
|
||||
|
||||
export interface PackSummary {
|
||||
readonly id: string;
|
||||
readonly name: string;
|
||||
readonly description?: string | null;
|
||||
readonly type: 'emoji' | 'sticker';
|
||||
readonly item_count: number;
|
||||
readonly preview_items: ReadonlyArray<{
|
||||
readonly id: string;
|
||||
readonly name: string;
|
||||
}>;
|
||||
}
|
||||
|
||||
export interface PackInvite extends InviteBase {
|
||||
readonly type: typeof InviteTypes.EMOJI_PACK | typeof InviteTypes.STICKER_PACK;
|
||||
readonly pack: PackSummary & {readonly creator: UserPartialResponse};
|
||||
}
|
||||
|
||||
export type Invite = GuildInvite | GroupDmInvite | PackInvite;
|
||||
Reference in New Issue
Block a user