@helyx/module-account-gate 1.0.1

package/manifest.json

@@ -0,0 +1,750 @@
+{
+  "manifestVersion": "0.2",
+  "releaseStatus": "live",
+  "id": "helyx.account-gate",
+  "name": "Access Control",
+  "version": "1.0.1",
+  "description": "Require new members to complete configurable Discord interaction checks before gaining access.",
+  "entry": "./dist/index.js",
+  "framework": "^0.1.0",
+  "dependencies": [],
+  "permissions": [
+    "ADD_REACTIONS",
+    "EMBED_LINKS",
+    "KICK_MEMBERS",
+    "MANAGE_MESSAGES",
+    "MANAGE_ROLES",
+    "READ_MESSAGE_HISTORY",
+    "SEND_MESSAGES",
+    "VIEW_CHANNEL"
+  ],
+  "privacy": {
+    "containsPersonalData": true,
+    "providerVersion": 1,
+    "collections": [
+      {
+        "name": "question_creators",
+        "createdAtField": "created_at",
+        "subjectFields": [
+          {
+            "field": "creator_user_id",
+            "role": "question-creator",
+            "erasure": "delete-record"
+          }
+        ]
+      },
+      {
+        "name": "attempts",
+        "createdAtField": "created_at",
+        "subjectFields": [
+          {
+            "field": "member_user_id",
+            "role": "member",
+            "erasure": "delete-record"
+          }
+        ]
+      },
+      {
+        "name": "member_summaries",
+        "createdAtField": "created_at",
+        "subjectFields": [
+          {
+            "field": "member_user_id",
+            "role": "member",
+            "erasure": "delete-record"
+          }
+        ]
+      },
+      {
+        "name": "reviews",
+        "createdAtField": "created_at",
+        "subjectFields": [
+          {
+            "field": "member_user_id",
+            "role": "reviewed-member",
+            "erasure": "delete-record"
+          },
+          {
+            "field": "decided_by_user_id",
+            "role": "staff-decision-actor",
+            "erasure": "set-null"
+          }
+        ]
+      },
+      {
+        "name": "terminal_finalizations",
+        "createdAtField": "created_at",
+        "subjectFields": [
+          {
+            "field": "member_user_id",
+            "role": "member",
+            "erasure": "delete-record"
+          }
+        ]
+      },
+      {
+        "name": "role_transitions",
+        "createdAtField": "created_at",
+        "subjectFields": [
+          {
+            "field": "member_user_id",
+            "role": "member",
+            "erasure": "delete-record"
+          }
+        ]
+      },
+      {
+        "name": "strict_modes",
+        "createdAtField": "created_at",
+        "subjectFields": [
+          {
+            "field": "activated_by_user_id",
+            "role": "strict-mode-actor",
+            "erasure": "set-null"
+          }
+        ]
+      },
+      {
+        "name": "privacy_suppressions",
+        "createdAtField": "created_at",
+        "subjectFields": [
+          {
+            "field": "member_user_id",
+            "role": "privacy-suppression",
+            "erasure": "retain"
+          }
+        ]
+      }
+    ]
+  },
+  "dashboard": {
+    "category": "safety",
+    "icon": "shield-check",
+    "settings": [
+      {
+        "key": "accessType",
+        "type": "select",
+        "label": "Access type",
+        "description": "Select the type of access panel you want to configure.",
+        "group": "Access type",
+        "required": true,
+        "supportVisibility": "value",
+        "options": [
+          {
+            "value": "challenges",
+            "label": "Challenges"
+          },
+          {
+            "value": "password",
+            "label": "Password",
+            "requiredDiscordCapability": "message-content"
+          },
+          {
+            "value": "emoji",
+            "label": "Emoji"
+          }
+        ],
+        "default": "challenges"
+      },
+      {
+        "key": "gateChannelId",
+        "type": "discord-channel",
+        "label": "Gate channel",
+        "description": "Select the channel where the access panel will be posted.",
+        "group": "Discord access",
+        "required": true,
+        "supportVisibility": "value",
+        "channelTypes": ["guild_text"]
+      },
+      {
+        "key": "verifiedRoleId",
+        "type": "discord-role",
+        "label": "Access role",
+        "description": "Role added only after the complete configured gate succeeds.",
+        "group": "Discord access",
+        "required": true,
+        "supportVisibility": "value",
+        "multiple": false
+      },
+      {
+        "key": "temporaryRoleIds",
+        "type": "discord-role",
+        "label": "Temporary roles",
+        "description": "Roles removed after Helyx has added the access role.",
+        "group": "Discord access",
+        "required": false,
+        "supportVisibility": "value",
+        "multiple": true
+      },
+      {
+        "key": "reviewChannelId",
+        "type": "discord-channel",
+        "label": "Staff review channel",
+        "description": "Private channel that receives checks requiring a staff decision.",
+        "group": "Staff review",
+        "required": false,
+        "supportVisibility": "value",
+        "channelTypes": ["guild_text"]
+      },
+      {
+        "key": "preset",
+        "type": "select",
+        "label": "Challenge preset",
+        "description": "Standard uses two different generated challenges.",
+        "group": "Challenges",
+        "required": true,
+        "supportVisibility": "value",
+        "visibleWhen": {
+          "field": "accessType",
+          "equals": "challenges"
+        },
+        "options": [
+          {
+            "value": "light",
+            "label": "Light"
+          },
+          {
+            "value": "standard",
+            "label": "Standard"
+          },
+          {
+            "value": "strict",
+            "label": "Strict"
+          },
+          {
+            "value": "custom",
+            "label": "Custom"
+          }
+        ],
+        "default": "standard"
+      },
+      {
+        "key": "allocationMode",
+        "type": "select",
+        "label": "Allocation mode",
+        "description": "Choose random, fixed or local adaptive challenge allocation.",
+        "group": "Challenges",
+        "required": true,
+        "supportVisibility": "value",
+        "visibleWhen": {
+          "field": "accessType",
+          "equals": "challenges"
+        },
+        "options": [
+          {
+            "value": "random_one",
+            "label": "Random one"
+          },
+          {
+            "value": "random_chain",
+            "label": "Random chain"
+          },
+          {
+            "value": "fixed_chain",
+            "label": "Fixed chain"
+          },
+          {
+            "value": "adaptive_chain",
+            "label": "Adaptive chain"
+          }
+        ],
+        "default": "random_chain"
+      },
+      {
+        "key": "enabledChallengeTypes",
+        "type": "string",
+        "label": "Enabled challenge types",
+        "description": "Comma-separated challenge IDs. Static gates are not randomly allocated.",
+        "group": "Challenges",
+        "required": true,
+        "supportVisibility": "value",
+        "visibleWhen": {
+          "field": "accessType",
+          "equals": "challenges"
+        },
+        "minLength": 0,
+        "maxLength": 300,
+        "default": "quick_sum,button_sequence,number_order,symbol_match,modal_recall"
+      },
+      {
+        "key": "fixedChallengeChain",
+        "type": "string",
+        "label": "Fixed challenge chain",
+        "description": "Comma-separated enabled challenge IDs used only in fixed-chain mode.",
+        "group": "Challenges",
+        "required": false,
+        "supportVisibility": "value",
+        "visibleWhen": {
+          "field": "accessType",
+          "equals": "challenges"
+        },
+        "minLength": 0,
+        "maxLength": 300,
+        "default": ""
+      },
+      {
+        "key": "challengeCount",
+        "type": "integer",
+        "label": "Challenge count",
+        "description": "Routine checks should use no more than three challenges.",
+        "group": "Challenges",
+        "required": true,
+        "supportVisibility": "value",
+        "visibleWhen": {
+          "field": "accessType",
+          "equals": "challenges"
+        },
+        "minimum": 1,
+        "maximum": 4,
+        "default": 2
+      },
+      {
+        "key": "attempts",
+        "type": "integer",
+        "label": "Attempts",
+        "description": "Number of complete check attempts before final failure.",
+        "group": "Timing and attempts",
+        "required": true,
+        "supportVisibility": "value",
+        "minimum": 1,
+        "maximum": 10,
+        "default": 3
+      },
+      {
+        "key": "sessionExpirySeconds",
+        "type": "integer",
+        "label": "Session expiry",
+        "description": "Seconds before an unfinished interaction session expires.",
+        "group": "Timing and attempts",
+        "required": true,
+        "supportVisibility": "value",
+        "minimum": 60,
+        "maximum": 600,
+        "default": 180
+      },
+      {
+        "key": "retryCooldownSeconds",
+        "type": "integer",
+        "label": "Retry cooldown",
+        "description": "Seconds before a failed member may start another attempt.",
+        "group": "Timing and attempts",
+        "required": true,
+        "supportVisibility": "value",
+        "minimum": 0,
+        "maximum": 600,
+        "default": 30
+      },
+      {
+        "key": "joinDeadlineSeconds",
+        "type": "integer",
+        "label": "Join deadline",
+        "description": "Seconds a joining member has to complete Access Control.",
+        "group": "Timing and attempts",
+        "required": true,
+        "supportVisibility": "value",
+        "minimum": 300,
+        "maximum": 3600,
+        "default": 900
+      },
+      {
+        "key": "failureAction",
+        "type": "select",
+        "label": "Final failure action",
+        "description": "Keep restricted, request staff review or send a neutral direct message and kick.",
+        "group": "Final failure",
+        "required": true,
+        "supportVisibility": "value",
+        "options": [
+          {
+            "value": "restricted",
+            "label": "Keep restricted"
+          },
+          {
+            "value": "review",
+            "label": "Staff review"
+          },
+          {
+            "value": "kick",
+            "label": "Kick"
+          }
+        ],
+        "default": "review"
+      },
+      {
+        "key": "strictModeDurationMinutes",
+        "type": "integer",
+        "label": "Strict-mode duration",
+        "description": "Temporary strict mode expires automatically after 5 to 60 minutes.",
+        "group": "Temporary strict mode",
+        "required": true,
+        "supportVisibility": "value",
+        "minimum": 5,
+        "maximum": 60,
+        "default": 15
+      },
+      {
+        "key": "minimumAccountAgeDays",
+        "type": "integer",
+        "label": "Minimum account age",
+        "description": "Minimum Discord account age in days; zero disables this local rule.",
+        "group": "Local account rules",
+        "required": true,
+        "supportVisibility": "value",
+        "minimum": 0,
+        "maximum": 3650,
+        "default": 0
+      },
+      {
+        "key": "reverifyReturningMembers",
+        "type": "boolean",
+        "label": "Recheck returning members",
+        "description": "Require returning members to complete Access Control again.",
+        "group": "Returning members",
+        "required": true,
+        "supportVisibility": "value",
+        "default": false
+      },
+      {
+        "key": "restoreVerifiedMembers",
+        "type": "boolean",
+        "label": "Restore previous access",
+        "description": "Restore the access role for previously successful returning members.",
+        "group": "Returning members",
+        "required": true,
+        "supportVisibility": "value",
+        "default": true
+      },
+      {
+        "key": "passwordChannelId",
+        "type": "discord-channel",
+        "label": "Password Entry channel",
+        "description": "Channel for a shared gate phrase; Message Content and Manage Messages are required.",
+        "group": "Password Entry",
+        "required": true,
+        "supportVisibility": "value",
+        "visibleWhen": {
+          "field": "accessType",
+          "equals": "password"
+        },
+        "channelTypes": ["guild_text"]
+      },
+      {
+        "key": "passwordIgnoreCase",
+        "type": "boolean",
+        "label": "Ignore letter case",
+        "description": "Compare each panel password without letter-case differences.",
+        "group": "Password Entry",
+        "required": true,
+        "supportVisibility": "value",
+        "visibleWhen": {
+          "field": "accessType",
+          "equals": "password"
+        },
+        "default": true
+      },
+      {
+        "key": "passwordTrimWhitespace",
+        "type": "boolean",
+        "label": "Ignore surrounding spaces",
+        "description": "Ignore leading and trailing spaces in each panel password.",
+        "group": "Password Entry",
+        "required": true,
+        "supportVisibility": "value",
+        "visibleWhen": {
+          "field": "accessType",
+          "equals": "password"
+        },
+        "default": true
+      },
+      {
+        "key": "emojiChannelId",
+        "type": "discord-channel",
+        "label": "Emoji Entry channel",
+        "description": "Channel containing the exact configured reaction message.",
+        "group": "Emoji Entry",
+        "required": true,
+        "supportVisibility": "value",
+        "visibleWhen": {
+          "field": "accessType",
+          "equals": "emoji"
+        },
+        "channelTypes": ["guild_text", "guild_announcement"]
+      },
+      {
+        "key": "emojiMessageId",
+        "type": "string",
+        "label": "Emoji Entry message ID",
+        "description": "Exact Discord message ID validated during setup.",
+        "group": "Emoji Entry",
+        "required": true,
+        "supportVisibility": "value",
+        "visibleWhen": {
+          "field": "accessType",
+          "equals": "emoji"
+        },
+        "minLength": 0,
+        "maxLength": 20,
+        "default": ""
+      },
+      {
+        "key": "emojiIdentifier",
+        "type": "string",
+        "label": "Emoji Entry emoji",
+        "description": "Exact Unicode or accessible server emoji used on the configured message.",
+        "group": "Emoji Entry",
+        "required": true,
+        "supportVisibility": "value",
+        "visibleWhen": {
+          "field": "accessType",
+          "equals": "emoji"
+        },
+        "minLength": 0,
+        "maxLength": 100,
+        "default": "",
+        "display": "emoji"
+      }
+    ],
+    "actions": [
+      {
+        "id": "activate-strict-mode",
+        "label": "Temporary strict mode",
+        "description": "Add one generated challenge temporarily, without changing attempts or failure actions.",
+        "buttonLabel": "Activate strict mode",
+        "style": "danger"
+      }
+    ],
+    "resources": [
+      {
+        "id": "gate-panel",
+        "name": "Gate panels",
+        "singularName": "Gate panel",
+        "description": "Edit, repair, repost or remove each published Access Control panel. Password Entry passwords belong to their individual panel.",
+        "columns": [
+          {
+            "key": "channelId",
+            "label": "Channel"
+          },
+          {
+            "key": "messageId",
+            "label": "Message"
+          }
+        ],
+        "operations": [
+          "list",
+          "read",
+          "preview",
+          "create",
+          "update",
+          "delete",
+          "action"
+        ],
+        "creationIntents": ["publish"],
+        "publicationMode": "validate_on_publish",
+        "editableFields": [
+          {
+            "statuses": ["posted", "missing"],
+            "fields": ["messageBody", "replacementPhrase"]
+          }
+        ],
+        "actions": [
+          {
+            "id": "repair",
+            "label": "Repair panel",
+            "description": "Restore the saved panel message in place, or publish a replacement when it is missing.",
+            "style": "secondary"
+          },
+          {
+            "id": "repost",
+            "label": "Repost panel",
+            "description": "Publish a replacement panel message and retire the previous message.",
+            "style": "secondary",
+            "confirmation": "Repost the Access Control panel and replace its current Discord message?"
+          }
+        ],
+        "fields": [
+          {
+            "key": "accessType",
+            "type": "select",
+            "label": "Access type",
+            "description": "The access type captured when this gate was published.",
+            "required": true,
+            "options": [
+              {
+                "value": "challenges",
+                "label": "Challenges"
+              },
+              {
+                "value": "password",
+                "label": "Password"
+              },
+              {
+                "value": "emoji",
+                "label": "Emoji"
+              }
+            ],
+            "default": "challenges"
+          },
+          {
+            "key": "messageBody",
+            "type": "string",
+            "label": "Message",
+            "description": "Instructions shown to members. Challenge and Password panels add a Start check button; Emoji panels remain instruction-only.",
+            "required": true,
+            "minLength": 1,
+            "maxLength": 1000,
+            "default": "Complete a short human-interaction check to access the server. Press the button below when you are ready.",
+            "multiline": true,
+            "group": "Message"
+          },
+          {
+            "key": "replacementPhrase",
+            "type": "string",
+            "label": "Password",
+            "description": "Enter a replacement password only when you want to change it. Helyx stores a one-way hash and cannot display it again.",
+            "required": false,
+            "minLength": 4,
+            "maxLength": 200,
+            "group": "Password Entry",
+            "visibleWhen": {
+              "field": "accessType",
+              "equals": "password"
+            }
+          }
+        ]
+      },
+      {
+        "id": "members",
+        "name": "Members",
+        "singularName": "Member",
+        "description": "Members known to Access Control, with live Discord identity and access state.",
+        "columns": [
+          {
+            "key": "memberUserId",
+            "label": "User ID"
+          },
+          {
+            "key": "displayName",
+            "label": "Display name"
+          },
+          {
+            "key": "avatarUrl",
+            "label": "Avatar"
+          },
+          {
+            "key": "memberPresent",
+            "label": "Server member"
+          },
+          {
+            "key": "completedAt",
+            "label": "Access granted"
+          }
+        ],
+        "operations": ["list", "action"],
+        "actions": [
+          {
+            "id": "revoke",
+            "permissionId": "account-gate.manage",
+            "label": "Revoke access",
+            "description": "Remove the configured access role and mark this Access Control member as revoked.",
+            "style": "danger",
+            "confirmation": "Revoke this member's Access Control access?",
+            "statuses": ["passed"]
+          }
+        ],
+        "query": {
+          "search": {
+            "label": "Search members",
+            "placeholder": "Current Discord display name or user ID"
+          }
+        },
+        "fields": [
+          {
+            "key": "memberUserId",
+            "type": "string",
+            "label": "Discord user ID",
+            "description": "The Discord user ID held by Access Control.",
+            "required": true,
+            "minLength": 17,
+            "maxLength": 20
+          }
+        ]
+      },
+      {
+        "id": "server-questions",
+        "name": "Server questions",
+        "singularName": "Server question",
+        "description": "Create simple server-rule questions with one correct answer.",
+        "columns": [
+          {
+            "key": "status",
+            "label": "State"
+          },
+          {
+            "key": "updatedAt",
+            "label": "Last changed"
+          }
+        ],
+        "operations": ["list", "read", "preview", "create", "update", "delete"],
+        "creationIntents": ["draft", "publish"],
+        "publicationMode": "preview_confirm",
+        "fields": [
+          {
+            "key": "question",
+            "type": "string",
+            "label": "Question",
+            "description": "Short server-rule or community-expectation question.",
+            "required": true,
+            "group": "Question",
+            "minLength": 1,
+            "maxLength": 200
+          },
+          {
+            "key": "correctAnswer",
+            "type": "string",
+            "label": "Correct answer",
+            "description": "The one answer Helyx accepts.",
+            "required": true,
+            "group": "Answers",
+            "minLength": 1,
+            "maxLength": 80
+          },
+          {
+            "key": "incorrectAnswers",
+            "type": "string",
+            "label": "Incorrect answers",
+            "description": "Enter two to four incorrect answers, one per line.",
+            "required": true,
+            "group": "Answers",
+            "minLength": 3,
+            "maxLength": 323
+          },
+          {
+            "key": "enabled",
+            "type": "boolean",
+            "label": "Enabled",
+            "description": "Allow this question to be selected for new checks.",
+            "required": true,
+            "group": "Availability",
+            "default": true
+          }
+        ]
+      }
+    ]
+  },
+  "contributions": {
+    "commands": ["access-control"],
+    "events": [
+      "discord.guild-member-add",
+      "discord.guild-member-remove",
+      "discord.message-reaction-add",
+      "discord.privileged-message-create"
+    ],
+    "logs": [
+      "account-gate-completed",
+      "account-gate-review-created",
+      "account-gate-kicked",
+      "account-gate-strict-mode-changed",
+      "account-gate-resume-notice"
+    ]
+  }
+}