@kodelyth/tlon 2026.5.42 → 2026.6.2

package/src/settings.ts

@@ -1,391 +0,0 @@
-/**
- * Settings Store integration for hot-reloading Tlon plugin config.
- *
- * Settings are stored in Urbit's %settings agent under:
- *   desk: "moltbot"
- *   bucket: "tlon"
- *
- * This allows config changes via poke from any Landscape client
- * without requiring a gateway restart.
- */
-
-import type { UrbitSSEClient } from "./urbit/sse-client.js";
-
-/** Pending approval request stored for persistence */
-export type PendingApproval = {
-  id: string;
-  type: "dm" | "channel" | "group";
-  requestingShip: string;
-  channelNest?: string;
-  groupFlag?: string;
-  messagePreview?: string;
-  /** Full message context for processing after approval */
-  originalMessage?: {
-    messageId: string;
-    messageText: string;
-    messageContent: unknown;
-    timestamp: number;
-    parentId?: string;
-    isThreadReply?: boolean;
-  };
-  timestamp: number;
-};
-
-export type TlonSettingsStore = {
-  groupChannels?: string[];
-  dmAllowlist?: string[];
-  autoDiscover?: boolean;
-  showModelSig?: boolean;
-  autoAcceptDmInvites?: boolean;
-  autoDiscoverChannels?: boolean;
-  autoAcceptGroupInvites?: boolean;
-  /** Ships allowed to invite us to groups (when autoAcceptGroupInvites is true) */
-  groupInviteAllowlist?: string[];
-  channelRules?: Record<
-    string,
-    {
-      mode?: "restricted" | "open";
-      allowedShips?: string[];
-    }
-  >;
-  defaultAuthorizedShips?: string[];
-  /** Ship that receives approval requests for DMs, channel mentions, and group invites */
-  ownerShip?: string;
-  /** Pending approval requests awaiting owner response */
-  pendingApprovals?: PendingApproval[];
-};
-
-type TlonSettingsState = {
-  current: TlonSettingsStore;
-  loaded: boolean;
-};
-
-const SETTINGS_DESK = "moltbot";
-const SETTINGS_BUCKET = "tlon";
-
-/**
- * Parse channelRules - handles both JSON string and object formats.
- * Settings-store doesn't support nested objects, so we store as JSON string.
- */
-function parseChannelRules(
-  value: unknown,
-): Record<string, { mode?: "restricted" | "open"; allowedShips?: string[] }> | undefined {
-  if (!value) {
-    return undefined;
-  }
-
-  // If it's a string, try to parse as JSON
-  if (typeof value === "string") {
-    try {
-      const parsed = JSON.parse(value);
-      if (isChannelRulesObject(parsed)) {
-        return parsed;
-      }
-    } catch {
-      return undefined;
-    }
-  }
-
-  // If it's already an object, use directly
-  if (isChannelRulesObject(value)) {
-    return value;
-  }
-
-  return undefined;
-}
-
-/**
- * Parse settings from the raw Urbit settings-store response.
- * The response shape is: { [bucket]: { [key]: value } }
- */
-function parseSettingsResponse(raw: unknown): TlonSettingsStore {
-  if (!raw || typeof raw !== "object") {
-    return {};
-  }
-
-  const desk = raw as Record<string, unknown>;
-  const bucket = desk[SETTINGS_BUCKET];
-  if (!bucket || typeof bucket !== "object") {
-    return {};
-  }
-
-  const settings = bucket as Record<string, unknown>;
-
-  return {
-    groupChannels: Array.isArray(settings.groupChannels)
-      ? settings.groupChannels.filter((x): x is string => typeof x === "string")
-      : undefined,
-    dmAllowlist: Array.isArray(settings.dmAllowlist)
-      ? settings.dmAllowlist.filter((x): x is string => typeof x === "string")
-      : undefined,
-    autoDiscover: typeof settings.autoDiscover === "boolean" ? settings.autoDiscover : undefined,
-    showModelSig: typeof settings.showModelSig === "boolean" ? settings.showModelSig : undefined,
-    autoAcceptDmInvites:
-      typeof settings.autoAcceptDmInvites === "boolean" ? settings.autoAcceptDmInvites : undefined,
-    autoAcceptGroupInvites:
-      typeof settings.autoAcceptGroupInvites === "boolean"
-        ? settings.autoAcceptGroupInvites
-        : undefined,
-    groupInviteAllowlist: Array.isArray(settings.groupInviteAllowlist)
-      ? settings.groupInviteAllowlist.filter((x): x is string => typeof x === "string")
-      : undefined,
-    channelRules: parseChannelRules(settings.channelRules),
-    defaultAuthorizedShips: Array.isArray(settings.defaultAuthorizedShips)
-      ? settings.defaultAuthorizedShips.filter((x): x is string => typeof x === "string")
-      : undefined,
-    ownerShip: typeof settings.ownerShip === "string" ? settings.ownerShip : undefined,
-    pendingApprovals: parsePendingApprovals(settings.pendingApprovals),
-  };
-}
-
-function isChannelRulesObject(
-  val: unknown,
-): val is Record<string, { mode?: "restricted" | "open"; allowedShips?: string[] }> {
-  if (!val || typeof val !== "object" || Array.isArray(val)) {
-    return false;
-  }
-  for (const [, rule] of Object.entries(val)) {
-    if (!rule || typeof rule !== "object") {
-      return false;
-    }
-  }
-  return true;
-}
-
-/**
- * Parse pendingApprovals - handles both JSON string and array formats.
- * Settings-store stores complex objects as JSON strings.
- */
-function parsePendingApprovals(value: unknown): PendingApproval[] | undefined {
-  if (!value) {
-    return undefined;
-  }
-
-  // If it's a string, try to parse as JSON
-  let parsed: unknown = value;
-  if (typeof value === "string") {
-    try {
-      parsed = JSON.parse(value);
-    } catch {
-      return undefined;
-    }
-  }
-
-  // Validate it's an array
-  if (!Array.isArray(parsed)) {
-    return undefined;
-  }
-
-  // Filter to valid PendingApproval objects
-  return parsed.filter((item): item is PendingApproval => {
-    if (!item || typeof item !== "object") {
-      return false;
-    }
-    const obj = item as Record<string, unknown>;
-    return (
-      typeof obj.id === "string" &&
-      (obj.type === "dm" || obj.type === "channel" || obj.type === "group") &&
-      typeof obj.requestingShip === "string" &&
-      typeof obj.timestamp === "number"
-    );
-  });
-}
-
-/**
- * Parse a single settings entry update event.
- */
-function parseSettingsEvent(event: unknown): { key: string; value: unknown } | null {
-  if (!event || typeof event !== "object") {
-    return null;
-  }
-
-  const evt = event as Record<string, unknown>;
-
-  // Handle put-entry events
-  if (evt["put-entry"]) {
-    const put = evt["put-entry"] as Record<string, unknown>;
-    if (put.desk !== SETTINGS_DESK || put["bucket-key"] !== SETTINGS_BUCKET) {
-      return null;
-    }
-    return {
-      key: typeof put["entry-key"] === "string" ? put["entry-key"] : "",
-      value: put.value,
-    };
-  }
-
-  // Handle del-entry events
-  if (evt["del-entry"]) {
-    const del = evt["del-entry"] as Record<string, unknown>;
-    if (del.desk !== SETTINGS_DESK || del["bucket-key"] !== SETTINGS_BUCKET) {
-      return null;
-    }
-    return {
-      key: typeof del["entry-key"] === "string" ? del["entry-key"] : "",
-      value: undefined,
-    };
-  }
-
-  return null;
-}
-
-/**
- * Apply a single settings update to the current state.
- */
-function applySettingsUpdate(
-  current: TlonSettingsStore,
-  key: string,
-  value: unknown,
-): TlonSettingsStore {
-  const next = { ...current };
-
-  switch (key) {
-    case "groupChannels":
-      next.groupChannels = Array.isArray(value)
-        ? value.filter((x): x is string => typeof x === "string")
-        : undefined;
-      break;
-    case "dmAllowlist":
-      next.dmAllowlist = Array.isArray(value)
-        ? value.filter((x): x is string => typeof x === "string")
-        : undefined;
-      break;
-    case "autoDiscover":
-      next.autoDiscover = typeof value === "boolean" ? value : undefined;
-      break;
-    case "showModelSig":
-      next.showModelSig = typeof value === "boolean" ? value : undefined;
-      break;
-    case "autoAcceptDmInvites":
-      next.autoAcceptDmInvites = typeof value === "boolean" ? value : undefined;
-      break;
-    case "autoAcceptGroupInvites":
-      next.autoAcceptGroupInvites = typeof value === "boolean" ? value : undefined;
-      break;
-    case "groupInviteAllowlist":
-      next.groupInviteAllowlist = Array.isArray(value)
-        ? value.filter((x): x is string => typeof x === "string")
-        : undefined;
-      break;
-    case "channelRules":
-      next.channelRules = parseChannelRules(value);
-      break;
-    case "defaultAuthorizedShips":
-      next.defaultAuthorizedShips = Array.isArray(value)
-        ? value.filter((x): x is string => typeof x === "string")
-        : undefined;
-      break;
-    case "ownerShip":
-      next.ownerShip = typeof value === "string" ? value : undefined;
-      break;
-    case "pendingApprovals":
-      next.pendingApprovals = parsePendingApprovals(value);
-      break;
-  }
-
-  return next;
-}
-
-type SettingsLogger = {
-  log?: (msg: string) => void;
-  error?: (msg: string) => void;
-};
-
-/**
- * Create a settings store subscription manager.
- *
- * Usage:
- *   const settings = createSettingsManager(api, logger);
- *   await settings.load();
- *   settings.subscribe((newSettings) => { ... });
- */
-export function createSettingsManager(api: UrbitSSEClient, logger?: SettingsLogger) {
-  let state: TlonSettingsState = {
-    current: {},
-    loaded: false,
-  };
-
-  const listeners = new Set<(settings: TlonSettingsStore) => void>();
-
-  const notify = () => {
-    for (const listener of listeners) {
-      try {
-        listener(state.current);
-      } catch (err) {
-        logger?.error?.(`[settings] Listener error: ${String(err)}`);
-      }
-    }
-  };
-
-  return {
-    /**
-     * Get current settings (may be empty if not loaded yet).
-     */
-    get current(): TlonSettingsStore {
-      return state.current;
-    },
-
-    /**
-     * Whether initial settings have been loaded.
-     */
-    get loaded(): boolean {
-      return state.loaded;
-    },
-
-    /**
-     * Load initial settings via scry.
-     */
-    async load(): Promise<TlonSettingsStore> {
-      try {
-        const raw = await api.scry("/settings/all.json");
-        // Response shape: { all: { [desk]: { [bucket]: { [key]: value } } } }
-        const allData = raw as { all?: Record<string, Record<string, unknown>> };
-        const deskData = allData?.all?.[SETTINGS_DESK];
-        state.current = parseSettingsResponse(deskData ?? {});
-        state.loaded = true;
-        logger?.log?.(`[settings] Loaded: ${JSON.stringify(state.current)}`);
-        return state.current;
-      } catch (err) {
-        // Settings desk may not exist yet - that's fine, use defaults
-        logger?.log?.(`[settings] No settings found (using defaults): ${String(err)}`);
-        state.current = {};
-        state.loaded = true;
-        return state.current;
-      }
-    },
-
-    /**
-     * Subscribe to settings changes.
-     */
-    async startSubscription(): Promise<void> {
-      await api.subscribe({
-        app: "settings",
-        path: "/desk/" + SETTINGS_DESK,
-        event: (event) => {
-          const update = parseSettingsEvent(event);
-          if (!update) {
-            return;
-          }
-
-          logger?.log?.(`[settings] Update: ${update.key} = ${JSON.stringify(update.value)}`);
-          state.current = applySettingsUpdate(state.current, update.key, update.value);
-          notify();
-        },
-        err: (error) => {
-          logger?.error?.(`[settings] Subscription error: ${String(error)}`);
-        },
-        quit: () => {
-          logger?.log?.("[settings] Subscription ended");
-        },
-      });
-      logger?.log?.("[settings] Subscribed to settings updates");
-    },
-
-    /**
-     * Register a listener for settings changes.
-     */
-    onChange(listener: (settings: TlonSettingsStore) => void): () => void {
-      listeners.add(listener);
-      return () => listeners.delete(listener);
-    },
-  };
-}

package/src/setup-core.ts

@@ -1,231 +0,0 @@
-import {
-  DEFAULT_ACCOUNT_ID,
-  formatDocsLink,
-  normalizeAccountId,
-  patchScopedAccountConfig,
-  prepareScopedSetupConfig,
-  createSetupTranslator,
-  createSetupInputPresenceValidator,
-  type ChannelSetupAdapter,
-  type ChannelSetupInput,
-  type ChannelSetupWizard,
-  type KlawConfig,
-} from "klaw/plugin-sdk/setup";
-import {
-  normalizeOptionalString,
-  normalizeStringifiedOptionalString,
-} from "klaw/plugin-sdk/string-coerce-runtime";
-import { buildTlonAccountFields, type TlonAccountFieldsInput } from "./account-fields.js";
-import { normalizeShip } from "./targets.js";
-import { listTlonAccountIds, resolveTlonAccount, type TlonResolvedAccount } from "./types.js";
-import { validateUrbitBaseUrl } from "./urbit/base-url.js";
-
-const t = createSetupTranslator();
-
-function tlonChannelId() {
-  return "tlon" as const;
-}
-
-type TlonSetupInput = ChannelSetupInput & TlonAccountFieldsInput;
-
-function isConfigured(account: TlonResolvedAccount): boolean {
-  return Boolean(account.ship && account.url && account.code);
-}
-
-type TlonSetupWizardBaseParams = {
-  resolveConfigured: (params: {
-    cfg: KlawConfig;
-    accountId?: string;
-  }) => boolean | Promise<boolean>;
-  resolveStatusLines?: (params: {
-    cfg: KlawConfig;
-    accountId?: string;
-    configured: boolean;
-  }) => string[] | Promise<string[]>;
-  finalize: NonNullable<ChannelSetupWizard["finalize"]>;
-};
-
-export function createTlonSetupWizardBase(params: TlonSetupWizardBaseParams): ChannelSetupWizard {
-  return {
-    channel: tlonChannelId(),
-    status: {
-      configuredLabel: t("wizard.channels.statusConfigured"),
-      unconfiguredLabel: t("wizard.channels.statusNeedsSetup"),
-      configuredHint: t("wizard.channels.statusConfigured"),
-      unconfiguredHint: t("wizard.channels.statusUrbitMessenger"),
-      configuredScore: 1,
-      unconfiguredScore: 4,
-      resolveConfigured: ({ cfg, accountId }) => params.resolveConfigured({ cfg, accountId }),
-      resolveStatusLines: ({ cfg, accountId, configured }) =>
-        params.resolveStatusLines?.({ cfg, accountId, configured }) ?? [],
-    },
-    introNote: {
-      title: t("wizard.tlon.setupTitle"),
-      lines: [
-        t("wizard.tlon.helpNeedsUrlCode"),
-        t("wizard.tlon.helpExampleUrl"),
-        t("wizard.tlon.helpExampleShip"),
-        t("wizard.tlon.helpPrivateNetwork"),
-        `Docs: ${formatDocsLink("/channels/tlon", "channels/tlon")}`,
-      ],
-    },
-    credentials: [],
-    textInputs: [
-      {
-        inputKey: "ship",
-        message: t("wizard.tlon.shipPrompt"),
-        placeholder: "~sampel-palnet",
-        currentValue: ({ cfg, accountId }) => resolveTlonAccount(cfg, accountId).ship ?? undefined,
-        validate: ({ value }) =>
-          normalizeStringifiedOptionalString(value) ? undefined : "Required",
-        normalizeValue: ({ value }) =>
-          normalizeShip(normalizeStringifiedOptionalString(value) ?? ""),
-        applySet: async ({ cfg, accountId, value }) =>
-          applyTlonSetupConfig({
-            cfg,
-            accountId,
-            input: { ship: value },
-          }),
-      },
-      {
-        inputKey: "url",
-        message: t("wizard.tlon.shipUrlPrompt"),
-        placeholder: "https://your-ship-host",
-        currentValue: ({ cfg, accountId }) => resolveTlonAccount(cfg, accountId).url ?? undefined,
-        validate: ({ value }) => {
-          const next = validateUrbitBaseUrl(value ?? "");
-          if (!next.ok) {
-            return next.error;
-          }
-          return undefined;
-        },
-        normalizeValue: ({ value }) => normalizeStringifiedOptionalString(value) ?? "",
-        applySet: async ({ cfg, accountId, value }) =>
-          applyTlonSetupConfig({
-            cfg,
-            accountId,
-            input: { url: value },
-          }),
-      },
-      {
-        inputKey: "code",
-        message: t("wizard.tlon.loginCodePrompt"),
-        placeholder: "lidlut-tabwed-pillex-ridrup",
-        currentValue: ({ cfg, accountId }) => resolveTlonAccount(cfg, accountId).code ?? undefined,
-        validate: ({ value }) =>
-          normalizeStringifiedOptionalString(value) ? undefined : "Required",
-        normalizeValue: ({ value }) => normalizeStringifiedOptionalString(value) ?? "",
-        applySet: async ({ cfg, accountId, value }) =>
-          applyTlonSetupConfig({
-            cfg,
-            accountId,
-            input: { code: value },
-          }),
-      },
-    ],
-    finalize: params.finalize,
-  };
-}
-
-export async function resolveTlonSetupConfigured(
-  cfg: KlawConfig,
-  accountId?: string,
-): Promise<boolean> {
-  if (accountId) {
-    return isConfigured(resolveTlonAccount(cfg, accountId));
-  }
-  const accountIds = listTlonAccountIds(cfg);
-  return accountIds.length > 0
-    ? accountIds.some((resolvedAccountId) =>
-        isConfigured(resolveTlonAccount(cfg, resolvedAccountId)),
-      )
-    : isConfigured(resolveTlonAccount(cfg, DEFAULT_ACCOUNT_ID));
-}
-
-export async function resolveTlonSetupStatusLines(
-  cfg: KlawConfig,
-  accountId?: string,
-): Promise<string[]> {
-  const configured = await resolveTlonSetupConfigured(cfg, accountId);
-  const label = accountId && accountId !== DEFAULT_ACCOUNT_ID ? `Tlon (${accountId})` : "Tlon";
-  return [`${label}: ${configured ? "configured" : "needs setup"}`];
-}
-
-export function applyTlonSetupConfig(params: {
-  cfg: KlawConfig;
-  accountId: string;
-  input: TlonSetupInput;
-}): KlawConfig {
-  const { cfg, accountId, input } = params;
-  const useDefault = accountId === DEFAULT_ACCOUNT_ID;
-  const namedConfig = prepareScopedSetupConfig({
-    cfg,
-    channelKey: tlonChannelId(),
-    accountId,
-    name: input.name,
-  });
-  const base = namedConfig.channels?.tlon ?? {};
-  const payload = buildTlonAccountFields(input);
-
-  if (useDefault) {
-    return {
-      ...namedConfig,
-      channels: {
-        ...namedConfig.channels,
-        tlon: {
-          ...base,
-          enabled: true,
-          ...payload,
-        },
-      },
-    };
-  }
-
-  return patchScopedAccountConfig({
-    cfg: namedConfig,
-    channelKey: tlonChannelId(),
-    accountId,
-    patch: { enabled: base.enabled ?? true },
-    accountPatch: {
-      enabled: true,
-      ...payload,
-    },
-    ensureChannelEnabled: false,
-    ensureAccountEnabled: false,
-  });
-}
-
-export const tlonSetupAdapter: ChannelSetupAdapter = {
-  resolveAccountId: ({ accountId }) => normalizeAccountId(accountId),
-  applyAccountName: ({ cfg, accountId, name }) =>
-    prepareScopedSetupConfig({
-      cfg,
-      channelKey: tlonChannelId(),
-      accountId,
-      name,
-    }),
-  validateInput: createSetupInputPresenceValidator({
-    validate: ({ cfg, accountId, input }) => {
-      const resolved = resolveTlonAccount(cfg, accountId ?? undefined);
-      const ship = normalizeOptionalString(input.ship) || resolved.ship;
-      const url = normalizeOptionalString(input.url) || resolved.url;
-      const code = normalizeOptionalString(input.code) || resolved.code;
-      if (!ship) {
-        return "Tlon requires --ship.";
-      }
-      if (!url) {
-        return "Tlon requires --url.";
-      }
-      if (!code) {
-        return "Tlon requires --code.";
-      }
-      return null;
-    },
-  }),
-  applyAccountConfig: ({ cfg, accountId, input }) =>
-    applyTlonSetupConfig({
-      cfg,
-      accountId,
-      input: input as TlonSetupInput,
-    }),
-};