@helyx/bot 1.1.0 → 1.2.0

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.
Files changed (85) hide show
  1. package/CHANGELOG.md +62 -0
  2. package/README.md +16 -1
  3. package/dist/auto-moderation-scanner-registry.d.ts +27 -0
  4. package/dist/auto-moderation-scanner-registry.js +172 -0
  5. package/dist/cloud-connector.js +3 -0
  6. package/dist/cloud-control-dispatcher.js +32 -0
  7. package/dist/command-path-contract.js +1 -0
  8. package/dist/control-permissions.d.ts +2 -2
  9. package/dist/control-permissions.js +4 -2
  10. package/dist/control-server.d.ts +72 -16
  11. package/dist/control-server.js +150 -250
  12. package/dist/dashboard-action-control.d.ts +25 -0
  13. package/dist/dashboard-action-control.js +73 -0
  14. package/dist/dashboard-action-routes.d.ts +9 -0
  15. package/dist/dashboard-action-routes.js +36 -0
  16. package/dist/dashboard-feature-control.d.ts +37 -0
  17. package/dist/dashboard-feature-control.js +206 -0
  18. package/dist/dashboard-module-projection.d.ts +9 -0
  19. package/dist/dashboard-module-projection.js +15 -0
  20. package/dist/dashboard-preview-import-routes.d.ts +6 -0
  21. package/dist/dashboard-preview-import-routes.js +121 -0
  22. package/dist/discord-analytics.d.ts +3 -0
  23. package/dist/discord-analytics.js +49 -5
  24. package/dist/discord-auto-moderation-service.d.ts +21 -0
  25. package/dist/discord-auto-moderation-service.js +425 -0
  26. package/dist/discord-guild-health.d.ts +2 -2
  27. package/dist/discord-member-enforcement-service.d.ts +26 -0
  28. package/dist/discord-member-enforcement-service.js +590 -0
  29. package/dist/discord-message-enforcement-service.d.ts +9 -0
  30. package/dist/discord-message-enforcement-service.js +102 -0
  31. package/dist/discord-violation-thread-service.d.ts +33 -0
  32. package/dist/discord-violation-thread-service.js +789 -0
  33. package/dist/ecko-evidence-receiver.d.ts +32 -0
  34. package/dist/ecko-evidence-receiver.js +173 -0
  35. package/dist/ecko-transport-auth.d.ts +19 -0
  36. package/dist/ecko-transport-auth.js +80 -0
  37. package/dist/ecko-transport-routes.d.ts +19 -0
  38. package/dist/ecko-transport-routes.js +130 -0
  39. package/dist/embedded-auto-moderation-pool.d.ts +46 -0
  40. package/dist/embedded-auto-moderation-pool.js +324 -0
  41. package/dist/embedded-auto-moderation-scanner.d.ts +34 -0
  42. package/dist/embedded-auto-moderation-scanner.js +263 -0
  43. package/dist/embedded-auto-moderation-worker-runtime.d.ts +37 -0
  44. package/dist/embedded-auto-moderation-worker-runtime.js +37 -0
  45. package/dist/embedded-auto-moderation-worker.d.ts +2 -0
  46. package/dist/embedded-auto-moderation-worker.js +13 -0
  47. package/dist/events.d.ts +5 -1
  48. package/dist/events.js +243 -4
  49. package/dist/guilds.d.ts +2 -2
  50. package/dist/guilds.js +14 -8
  51. package/dist/hosted-server-moderation.d.ts +16 -5
  52. package/dist/hosted-server-moderation.js +32 -4
  53. package/dist/index.d.ts +1 -1
  54. package/dist/index.js +84 -14
  55. package/dist/moderation-action-registry.d.ts +11 -0
  56. package/dist/moderation-action-registry.js +375 -0
  57. package/dist/moderation-case-disassociation.d.ts +13 -0
  58. package/dist/moderation-case-disassociation.js +83 -0
  59. package/dist/moderation-platform-services.d.ts +27 -0
  60. package/dist/moderation-platform-services.js +47 -0
  61. package/dist/modules.d.ts +6 -0
  62. package/dist/modules.js +65 -3
  63. package/dist/privileged-message-metadata-cache.d.ts +35 -0
  64. package/dist/privileged-message-metadata-cache.js +70 -0
  65. package/dist/scheduled-task-runner.js +24 -1
  66. package/dist/shard-contracts.d.ts +151 -1
  67. package/dist/shard-contracts.js +142 -1
  68. package/dist/shard-coordinator.d.ts +1 -1
  69. package/dist/shard-ecko-scanner-registry.d.ts +38 -0
  70. package/dist/shard-ecko-scanner-registry.js +96 -0
  71. package/dist/shard-router.d.ts +23 -0
  72. package/dist/shard-router.js +69 -5
  73. package/dist/shard-supervisor.d.ts +11 -0
  74. package/dist/shard-supervisor.js +67 -4
  75. package/dist/shard-worker.d.ts +15 -1
  76. package/dist/shard-worker.js +95 -17
  77. package/dist/transient-violation-evidence.d.ts +39 -0
  78. package/dist/transient-violation-evidence.js +132 -0
  79. package/documentation/README.md +2 -0
  80. package/documentation/examples/.env.example +12 -0
  81. package/documentation/guides/self-hosting.md +17 -1
  82. package/documentation/modules/auto-moderation.md +51 -0
  83. package/documentation/modules/moderation.md +42 -0
  84. package/documentation/reference/environment.md +11 -0
  85. package/package.json +17 -5
@@ -0,0 +1,102 @@
1
+ import { DiscordAPIError, PermissionFlagsBits, } from "discord.js";
2
+ const MODERATION_MODULE_ID = "helyx.moderation";
3
+ const SNOWFLAKE_PATTERN = /^\d{17,20}$/u;
4
+ const OPERATION_KEY_PATTERN = /^[A-Za-z0-9][A-Za-z0-9._:-]{0,159}$/u;
5
+ /** Deletes only a positively identified member-authored guild message. */
6
+ export class DiscordMessageEnforcementAdapter {
7
+ client;
8
+ constructor(client) {
9
+ this.client = client;
10
+ }
11
+ async deleteMemberMessage(input) {
12
+ validateInput(input);
13
+ if (input.callerModuleId !== MODERATION_MODULE_ID)
14
+ return result("failed", "caller_not_allowed");
15
+ const guild = this.client.guilds.cache.get(input.guildId);
16
+ if (!guild)
17
+ return result("failed", "guild_not_owned");
18
+ const channel = await guild.channels
19
+ .fetch(input.channelId)
20
+ .catch(() => null);
21
+ if (!channel ||
22
+ channel.guild.id !== input.guildId ||
23
+ !channel.isTextBased() ||
24
+ channel.isDMBased())
25
+ return result("already_absent");
26
+ const me = guild.members.me;
27
+ if (!me ||
28
+ !channel.permissionsFor(me).has(PermissionFlagsBits.ManageMessages))
29
+ return result("missing_permission", "manage_messages");
30
+ let message;
31
+ try {
32
+ message = await fetchMessage(channel, input.messageId);
33
+ }
34
+ catch (error) {
35
+ if (isDiscordStatus(error, 403))
36
+ return result("missing_permission", "discord_forbidden");
37
+ if (error instanceof DiscordAPIError)
38
+ return result("failed", `discord_${error.code}`.slice(0, 80));
39
+ return result("ambiguous", "discord_transport_unknown");
40
+ }
41
+ if (!message)
42
+ return result("already_absent");
43
+ if (message.guildId !== input.guildId ||
44
+ message.channelId !== input.channelId ||
45
+ message.author.id !== input.expectedAuthorUserId)
46
+ return result("author_mismatch");
47
+ if (!(await safelyRevalidate(() => input.revalidate())))
48
+ return result("failed", "revalidation_rejected");
49
+ try {
50
+ await message.delete();
51
+ return result("deleted");
52
+ }
53
+ catch (error) {
54
+ if (isDiscordStatus(error, 404))
55
+ return result("already_absent");
56
+ if (isDiscordStatus(error, 403))
57
+ return result("missing_permission", "discord_forbidden");
58
+ if (error instanceof DiscordAPIError)
59
+ return result("failed", `discord_${error.code}`.slice(0, 80));
60
+ return result("ambiguous", "discord_transport_unknown");
61
+ }
62
+ }
63
+ }
64
+ async function fetchMessage(channel, messageId) {
65
+ try {
66
+ return await channel.messages.fetch(messageId);
67
+ }
68
+ catch (error) {
69
+ if (isDiscordStatus(error, 404))
70
+ return null;
71
+ throw error;
72
+ }
73
+ }
74
+ function validateInput(input) {
75
+ for (const value of [
76
+ input.guildId,
77
+ input.channelId,
78
+ input.messageId,
79
+ input.expectedAuthorUserId,
80
+ ])
81
+ if (!SNOWFLAKE_PATTERN.test(value))
82
+ throw new Error("Message enforcement Discord identity is invalid");
83
+ if (!OPERATION_KEY_PATTERN.test(input.operationKey) ||
84
+ input.reason.trim().length < 1 ||
85
+ input.reason.length > 512)
86
+ throw new Error("Message enforcement metadata is invalid");
87
+ }
88
+ async function safelyRevalidate(revalidate) {
89
+ try {
90
+ return await revalidate();
91
+ }
92
+ catch {
93
+ return false;
94
+ }
95
+ }
96
+ function result(outcome, safeCode) {
97
+ return { outcome, ...(safeCode ? { safeCode } : {}) };
98
+ }
99
+ function isDiscordStatus(error, status) {
100
+ return error instanceof DiscordAPIError && error.status === status;
101
+ }
102
+ //# sourceMappingURL=discord-message-enforcement-service.js.map
@@ -0,0 +1,33 @@
1
+ import type { ViolationEvidenceReference, ViolationThreadConfigurationInspection, ViolationThreadDeliveryResult, ViolationThreadService } from "@helyx/sdk";
2
+ import { type Client } from "discord.js";
3
+ import type { TransientViolationEvidenceStore } from "./transient-violation-evidence.js";
4
+ /** Guild-owner-routed adapter for role-gated private violation threads. */
5
+ export declare class DiscordViolationThreadAdapter implements ViolationThreadService {
6
+ #private;
7
+ private readonly client;
8
+ constructor(client: Client);
9
+ inspectConfiguration(input: Parameters<ViolationThreadService["inspectConfiguration"]>[0]): Promise<ViolationThreadConfigurationInspection>;
10
+ createAccessRole(input: Parameters<ViolationThreadService["createAccessRole"]>[0]): ReturnType<ViolationThreadService["createAccessRole"]>;
11
+ configureParent(input: Parameters<ViolationThreadService["configureParent"]>[0]): ReturnType<ViolationThreadService["configureParent"]>;
12
+ create(input: Parameters<ViolationThreadService["create"]>[0]): ReturnType<ViolationThreadService["create"]>;
13
+ addMember(input: Parameters<ViolationThreadService["addMember"]>[0]): ReturnType<ViolationThreadService["addMember"]>;
14
+ removeMember(input: Parameters<ViolationThreadService["removeMember"]>[0]): ReturnType<ViolationThreadService["removeMember"]>;
15
+ send(input: Parameters<ViolationThreadService["send"]>[0]): ReturnType<ViolationThreadService["send"]>;
16
+ close(input: Parameters<ViolationThreadService["close"]>[0]): ReturnType<ViolationThreadService["close"]>;
17
+ reconcile(input: Parameters<ViolationThreadService["reconcile"]>[0]): ReturnType<ViolationThreadService["reconcile"]>;
18
+ }
19
+ export interface DiscordViolationEvidenceDeliveryInput {
20
+ guildId: string;
21
+ threadId: string;
22
+ evidenceReference: ViolationEvidenceReference;
23
+ operationKey: string;
24
+ }
25
+ /** Bot-private capability; never installed in the module service map. */
26
+ export declare class DiscordViolationEvidenceDeliveryAdapter {
27
+ #private;
28
+ private readonly client;
29
+ private readonly evidence;
30
+ constructor(client: Client, evidence: TransientViolationEvidenceStore);
31
+ deliverEvidence(input: DiscordViolationEvidenceDeliveryInput): Promise<ViolationThreadDeliveryResult>;
32
+ }
33
+ //# sourceMappingURL=discord-violation-thread-service.d.ts.map