gubo-data-types 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -72
- package/dist/guild.d.ts +2 -0
- package/dist/plugins/welcome.d.ts +2 -0
- package/dist/plugins/welcome.js +29 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
# gubo-data-types
|
|
2
|
-
|
|
3
|
-
Shared type definitions and default configurations for GUBO Discord Bot.
|
|
4
|
-
|
|
5
|
-
Este paquete contiene todas las definiciones de tipos TypeScript utilizadas por el bot GUBO, incluyendo configuraciones para plugins de moderaci�n, tickets, econom�a y m�s.
|
|
6
|
-
|
|
7
|
-
## Instalaci�n
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
npm install gubo-data-types
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Uso
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import {
|
|
17
|
-
GuildConfig,
|
|
18
|
-
WelcomeConfig,
|
|
19
|
-
GoodbyeConfig,
|
|
20
|
-
ModerationConfig,
|
|
21
|
-
TicketsConfig,
|
|
22
|
-
EconomyConfig,
|
|
23
|
-
ReactionRolesConfig
|
|
24
|
-
} from 'gubo-data-types';
|
|
25
|
-
|
|
26
|
-
// Usar los tipos en tu proyecto
|
|
27
|
-
const guildConfig: GuildConfig = {
|
|
28
|
-
id: "123456789",
|
|
29
|
-
name: "Mi Servidor",
|
|
30
|
-
plugins: {
|
|
31
|
-
welcome: {
|
|
32
|
-
enabled: true,
|
|
33
|
-
channel: "welcome-channel-id",
|
|
34
|
-
message: "�Bienvenido {user}!"
|
|
35
|
-
}
|
|
36
|
-
}
|
|
37
|
-
};
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
## Tipos disponibles
|
|
41
|
-
|
|
42
|
-
### GuildConfig
|
|
43
|
-
Configuraci�n principal del servidor con todos los plugins habilitados.
|
|
44
|
-
|
|
45
|
-
### Plugin Configs
|
|
46
|
-
- `WelcomeConfig`: Configuraci�n del plugin de bienvenida
|
|
47
|
-
- `GoodbyeConfig`: Configuraci�n del plugin de despedida
|
|
48
|
-
- `ModerationConfig`: Configuraci�n del plugin de moderaci�n
|
|
49
|
-
- `TicketsConfig`: Configuraci�n del sistema de tickets
|
|
50
|
-
- `EconomyConfig`: Configuraci�n del sistema de econom�a
|
|
51
|
-
- `ReactionRolesConfig`: Configuraci�n de roles por reacci�n
|
|
52
|
-
|
|
53
|
-
## Caracter�sticas
|
|
54
|
-
|
|
55
|
-
- ? Sin dependencias externas
|
|
56
|
-
- ? Tipos TypeScript completos
|
|
57
|
-
- ? Valores por defecto incluidos
|
|
58
|
-
- ? Compatible con cualquier bot de Discord
|
|
59
|
-
- ? Documentaci�n JSDoc incluida
|
|
60
|
-
|
|
61
|
-
## Compatibilidad
|
|
62
|
-
|
|
63
|
-
- Node.js 18+
|
|
64
|
-
- TypeScript 4.5+
|
|
65
|
-
|
|
66
|
-
## Licencia
|
|
67
|
-
|
|
68
|
-
MIT
|
|
69
|
-
|
|
70
|
-
## Contribuir
|
|
71
|
-
|
|
72
|
-
Este paquete es parte del proyecto [GUBO Discord Bot](https://github.com/zeekee/DiscordBot).
|
package/dist/guild.d.ts
CHANGED
|
@@ -3,6 +3,7 @@ export interface Plan {
|
|
|
3
3
|
tier: PlanTier;
|
|
4
4
|
expiresAt?: any | null;
|
|
5
5
|
isTrial?: boolean | null;
|
|
6
|
+
trialActivated?: boolean | null;
|
|
6
7
|
}
|
|
7
8
|
export interface GuildDoc {
|
|
8
9
|
name?: string;
|
|
@@ -13,4 +14,5 @@ export interface GuildDoc {
|
|
|
13
14
|
createdAt?: any;
|
|
14
15
|
updatedAt?: any;
|
|
15
16
|
locale?: string | null;
|
|
17
|
+
installed?: boolean;
|
|
16
18
|
}
|
|
@@ -3,6 +3,7 @@ export interface WelcomePluginConfig {
|
|
|
3
3
|
channelId?: string | null;
|
|
4
4
|
message?: string;
|
|
5
5
|
useEmbed?: boolean;
|
|
6
|
+
embedColor?: string | null;
|
|
6
7
|
imageUrl?: string | null;
|
|
7
8
|
autoRoleIds?: string[];
|
|
8
9
|
dmEnabled?: boolean;
|
|
@@ -12,5 +13,6 @@ export interface WelcomePluginConfig {
|
|
|
12
13
|
updatedAt?: any | null;
|
|
13
14
|
updatedBy?: string | null;
|
|
14
15
|
version?: number;
|
|
16
|
+
serverIconDisplay?: 'embed' | 'card' | 'none';
|
|
15
17
|
}
|
|
16
18
|
export declare const DEFAULT_WELCOME: WelcomePluginConfig;
|
package/dist/plugins/welcome.js
CHANGED
|
@@ -1,18 +1,44 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.DEFAULT_WELCOME = void 0;
|
|
4
|
+
const DEFAULT_WELCOME_MESSAGE = `{emoji:star} Welcome {{{user}}} to **{guild}**!
|
|
5
|
+
|
|
6
|
+
Your user ID is \`{user.id}\`, and your full tag is **{user.tag}**.
|
|
7
|
+
Your account, **{user.name}**, was created on **{user.createdAt}**, which was **{accountAge}** ago.
|
|
8
|
+
|
|
9
|
+
We now have **{memberCount} members** in total (you’re member #**{memberIndex}**).
|
|
10
|
+
Your highest role is **{topRole}**, and you currently have **{roleCount} roles**: {roles}.
|
|
11
|
+
|
|
12
|
+
You joined this server on **{joinedAt}**, which was founded on **{serverCreationDate}**,
|
|
13
|
+
and currently has **{boosts} boosts** ({premiumSubscriptionCount} premium subscribers).
|
|
14
|
+
|
|
15
|
+
The server ID is \`{guild.id}\`.
|
|
16
|
+
Are you a bot? **{isBot}**
|
|
17
|
+
|
|
18
|
+
We’re really glad to have you here {emoji:smile}!
|
|
19
|
+
|
|
20
|
+
Check out {#1234567890} to get started, and drop by {channel:9876543210} to introduce yourself.
|
|
21
|
+
|
|
22
|
+
{emoji:fire} Let the adventure begin!`;
|
|
23
|
+
const DEFAULT_DM_MESSAGE = `{emoji:star} Welcome {{{user}}}!
|
|
24
|
+
|
|
25
|
+
Your account **{user.name}** was created on **{user.createdAt}** ({accountAge} ago).
|
|
26
|
+
|
|
27
|
+
We’re excited to have you in **{guild}** — check out {#1234567890} to get started! {emoji:fire}`;
|
|
4
28
|
exports.DEFAULT_WELCOME = {
|
|
5
29
|
enabled: false,
|
|
6
30
|
channelId: null,
|
|
7
|
-
message:
|
|
31
|
+
message: DEFAULT_WELCOME_MESSAGE,
|
|
8
32
|
useEmbed: false,
|
|
33
|
+
embedColor: 'Red',
|
|
9
34
|
imageUrl: null,
|
|
10
35
|
autoRoleIds: [],
|
|
11
36
|
dmEnabled: false,
|
|
12
|
-
dmMessage:
|
|
37
|
+
dmMessage: DEFAULT_DM_MESSAGE,
|
|
13
38
|
dmImageUrl: null,
|
|
14
39
|
cardEnabled: false,
|
|
15
40
|
updatedAt: null,
|
|
16
41
|
updatedBy: null,
|
|
17
|
-
version: 0
|
|
42
|
+
version: 0,
|
|
43
|
+
serverIconDisplay: 'embed'
|
|
18
44
|
};
|