@helyx/cli 1.7.0 → 1.8.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.8.0
+
+### Minor Changes
+
+- Add helyx help connect, status and disconnect for opt-in online Help, encrypted local credentials and credential revocation. Package the compatible bot and updated self-host catalogue while retaining offline Help without enrolment.
+
 ## 1.7.0
 
 ### Minor Changes

package/dist/cli.js

@@ -7,6 +7,7 @@ import { resolveDatabaseAdapter } from "@helyx/database/adapters";
 import { formatCommandError } from "./errors.js";
 import { runSelfHostCommand } from "./self-host/command.js";
 import { loadLocalEnvironment, setupSelfHostEnvironment } from "./setup.js";
+import { runHelpCommand } from "./help-command.js";
 const command = process.argv[2];
 try {
     if (command === "start") {
@@ -31,6 +32,9 @@ try {
     else if (command === "self-host") {
         await runSelfHostCommand(process.argv.slice(3));
     }
+    else if (command === "help" && process.argv[3]) {
+        await runHelpCommand(process.argv.slice(3));
+    }
     else if (command === "help" || command === "--help" || command === "-h") {
         printHelp();
     }
@@ -149,6 +153,8 @@ Commands:
   start    Start the Helyx Discord bot
   migrate  Apply core migrations for the selected database engine and exit
   doctor   Validate environment, database schema and module packages
+  help connect|status|disconnect [--project <path>] [--confirm]
+           Manage optional Help-only online access; local Help needs no account
   self-host init --manifest <path> [--output <path>] [--install]
            Generate a self-hosted starter project from a reviewed manifest
   self-host update --check [--project <path>]

package/dist/help-command.d.ts

@@ -0,0 +1,8 @@
+export declare function runHelpCommand(args: readonly string[], options?: {
+    cwd?: string;
+    environment?: NodeJS.ProcessEnv;
+    question?: (prompt: string) => Promise<string>;
+    write?: (message: string) => void;
+    fetch?: typeof fetch;
+}): Promise<void>;
+//# sourceMappingURL=help-command.d.ts.map

package/dist/help-command.js

@@ -0,0 +1,71 @@
+import { resolve } from "node:path";
+import { createInterface } from "node:readline/promises";
+import { HelpCredentialStore, exchangeHelpEnrolment, revokeHelpCredential, } from "@helyx/bot";
+import { loadLocalEnvironment } from "./setup.js";
+export async function runHelpCommand(args, options = {}) {
+    const [action, ...rest] = args;
+    let directory = resolve(options.cwd ?? process.cwd()), confirm = false;
+    if (!["connect", "status", "disconnect"].includes(action ?? ""))
+        throw new Error("Use: helyx help connect|status|disconnect [--project <path>] [--confirm]");
+    for (let index = 0; index < rest.length; index++) {
+        if (rest[index] === "--project" && rest[index + 1])
+            directory = resolve(directory, rest[++index]);
+        else if (rest[index] === "--confirm")
+            confirm = true;
+        else
+            throw new Error("Unsupported Help option. Paste enrolment codes at the prompt, not in command arguments.");
+    }
+    const environment = { ...(options.environment ?? process.env) };
+    await loadLocalEnvironment(directory, environment);
+    if (!environment.HELYX_DATA_ENCRYPTION_KEY)
+        throw new Error("Set up the local HELYX_DATA_ENCRYPTION_KEY before managing online Help. Local Help remains available.");
+    if (action === "connect" &&
+        environment.HELYX_RUNTIME_PROFILE !== "self-hosted")
+        throw new Error("Online Help enrolment is for a self-hosted installation. Set HELYX_RUNTIME_PROFILE=self-hosted in that project's environment.");
+    const store = new HelpCredentialStore(directory, environment.HELYX_DATA_ENCRYPTION_KEY), write = options.write ?? console.log;
+    if (action === "status") {
+        const credential = await store.read();
+        write(!credential
+            ? "Help: local bundled FAQs. No online credential saved."
+            : `Help: ${Date.parse(credential.expiresAt) > Date.now() ? "online credential saved" : "credential expired; local FAQs remain available"}. Installation ${credential.installationId}. Expires ${credential.expiresAt}.`);
+        return;
+    }
+    if (action === "disconnect") {
+        const credential = await store.read();
+        let remote = true;
+        if (credential && Date.parse(credential.expiresAt) > Date.now())
+            try {
+                await revokeHelpCredential(credential.token, options.fetch);
+            }
+            catch {
+                remote = false;
+            }
+        await store.remove();
+        write(remote
+            ? "Online Help disconnected. Local bundled FAQs remain available."
+            : "Online Help disconnected locally. Revoke its credential from your dashboard when the service is available.");
+        return;
+    }
+    const reader = options.question
+        ? null
+        : createInterface({ input: process.stdin, output: process.stdout }), question = options.question ?? ((prompt) => reader.question(prompt));
+    try {
+        write("Optional online Help sends your public Helyx question to Helyx and its embedding provider. It does not connect guild settings or require Cloud Connect.");
+        if (!confirm &&
+            (await question("Type CONNECT to save an encrypted Help-only credential: ")).trim() !== "CONNECT") {
+            write("Cancelled. Local Help remains available.");
+            return;
+        }
+        const code = (await question("Paste the one-time Help code from your self-host dashboard: ")).trim();
+        const credential = await exchangeHelpEnrolment(code, options.fetch);
+        await store.save(credential);
+        write(`Online Help connected for installation ${credential.installationId}. Credential expires ${credential.expiresAt}.`);
+    }
+    catch {
+        throw new Error("Online Help could not be connected. Check the one-time code, service availability, local encryption key and write permissions. No credential value was printed.");
+    }
+    finally {
+        reader?.close();
+    }
+}
+//# sourceMappingURL=help-command.js.map

package/dist/index.d.ts

@@ -6,4 +6,5 @@ export * from "./self-host/manifest.js";
 export * from "./self-host/project-generator.js";
 export * from "./self-host/update.js";
 export * from "./setup.js";
+export * from "./help-command.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -6,4 +6,5 @@ export * from "./self-host/manifest.js";
 export * from "./self-host/project-generator.js";
 export * from "./self-host/update.js";
 export * from "./setup.js";
+export * from "./help-command.js";
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helyx/cli",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Command-line tools for running and generating self-hosted Helyx deployments.",
   "keywords": [
     "helyx",
@@ -52,9 +52,9 @@
     "build": "tsc -b"
   },
   "dependencies": {
-    "@helyx/bot": ">=1.6.0 <2.0.0",
-    "@helyx/config": ">=1.6.0 <2.0.0",
-    "@helyx/database": ">=2.5.0 <3.0.0",
+    "@helyx/bot": ">=1.7.0 <2.0.0",
+    "@helyx/config": ">=1.7.0 <2.0.0",
+    "@helyx/database": ">=2.5.1 <3.0.0",
     "semver": "7.8.5",
     "zod": "4.6.7"
   },

package/self-host-catalogue.json

@@ -1,21 +1,21 @@
 {
   "schemaVersion": 2,
-  "catalogueVersion": 88,
+  "catalogueVersion": 89,
   "core": {
     "package": "@helyx/bot",
-    "version": "1.6.0",
+    "version": "1.7.0",
     "availability": "published"
   },
   "generator": {
     "package": "@helyx/cli",
-    "version": "1.7.0",
+    "version": "1.8.0",
     "command": "helyx",
     "availability": "published"
   },
   "databaseAdapters": [
     {
       "package": "@helyx/database",
-      "version": "2.5.0"
+      "version": "2.5.1"
     },
     {
       "package": "@helyx/database-mysql",
@@ -273,7 +273,7 @@
     {
       "id": "helyx.account-gate",
       "package": "@helyx/module-account-gate",
-      "version": "2.1.2",
+      "version": "2.1.3",
       "name": "Access Control",
       "description": "Require new members to complete configurable Discord interaction checks before gaining access.",
       "category": "Safety",
@@ -558,7 +558,7 @@
     {
       "id": "helyx.reactionroles",
       "package": "@helyx/module-reactionroles",
-      "version": "1.1.2",
+      "version": "1.1.3",
       "name": "Reaction Roles",
       "description": "Let members select approved roles themselves.",
       "category": "Automation",
@@ -938,7 +938,7 @@
     {
       "id": "helyx.achievements",
       "package": "@helyx/module-achievements",
-      "version": "2.1.3",
+      "version": "2.1.4",
       "name": "Achievements",
       "description": "Configurable member milestones, scores and optional rewards.",
       "category": "Gaming",

package/templates/self-host/Dockerfile

@@ -9,6 +9,7 @@ COPY helyx.modules.json ./
 
 ENV HELYX_MODULE_CATALOGUE_PATH=/app/helyx.modules.json
 ENV NODE_ENV=production
+RUN mkdir -p /app/.helyx && chown node:node /app/.helyx
 
 USER node
 

package/templates/self-host/compose.mysql.yaml

@@ -4,3 +4,8 @@ services:
     restart: unless-stopped
     env_file:
       - .env
+    volumes:
+      - helyx-private:/app/.helyx
+
+volumes:
+  helyx-private:

package/templates/self-host/compose.yaml

@@ -4,6 +4,8 @@ services:
     restart: unless-stopped
     env_file:
       - .env
+    volumes:
+      - helyx-private:/app/.helyx
     depends_on:
       database:
         condition: service_healthy
@@ -25,3 +27,4 @@ services:
 
 volumes:
   helyx-database:
+  helyx-private: