openclaw/extensions/matrix/src/account-selection.ts

import {
  listCombinedAccountIds,
  listConfiguredAccountIds,
  resolveListedDefaultAccountId,
  resolveNormalizedAccountEntry,
} from "openclaw/plugin-sdk/account-core";
import {
  DEFAULT_ACCOUNT_ID,
  normalizeAccountId,
  normalizeOptionalAccountId,
} from "openclaw/plugin-sdk/account-id";
import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime";
import { hasConfiguredSecretInput } from "openclaw/plugin-sdk/secret-input";
import {
  resolveMatrixAccountStringValues,
  type MatrixResolvedStringField,
} from "./auth-precedence.js";
import { getMatrixScopedEnvVarNames, listMatrixEnvAccountIds } from "./env-vars.js";

function isRecord(value: unknown): value is Record<string, unknown> {
  return Boolean(value) && typeof value === "object" && !Array.isArray(value);
}

type MatrixTopologyStringSources = Partial<Record<MatrixResolvedStringField, string>>;

function readConfiguredMatrixString(value: unknown): string {
  return typeof value === "string" ? value.trim() : "";
}

function readConfiguredMatrixSecretSource(value: unknown): string {
  return hasConfiguredSecretInput(value) ? "configured" : "";
}

function resolveMatrixChannelStringSources(
  entry: Record<string, unknown> | null,
): MatrixTopologyStringSources {
  if (!entry) {
    return {};
  }
  return {
    homeserver: readConfiguredMatrixString(entry.homeserver),
    userId: readConfiguredMatrixString(entry.userId),
    accessToken: readConfiguredMatrixSecretSource(entry.accessToken),
    password: readConfiguredMatrixSecretSource(entry.password),
    deviceId: readConfiguredMatrixString(entry.deviceId),
    deviceName: readConfiguredMatrixString(entry.deviceName),
  };
}

function readEnvMatrixString(env: NodeJS.ProcessEnv, key: string): string {
  const value = env[key];
  return typeof value === "string" ? value.trim() : "";
}

function resolveScopedMatrixEnvStringSources(
  accountId: string,
  env: NodeJS.ProcessEnv,
): MatrixTopologyStringSources {
  const keys = getMatrixScopedEnvVarNames(accountId);
  return {
    homeserver: readEnvMatrixString(env, keys.homeserver),
    userId: readEnvMatrixString(env, keys.userId),
    accessToken: readEnvMatrixString(env, keys.accessToken),
    password: readEnvMatrixString(env, keys.password),
    deviceId: readEnvMatrixString(env, keys.deviceId),
    deviceName: readEnvMatrixString(env, keys.deviceName),
  };
}

function resolveGlobalMatrixEnvStringSources(env: NodeJS.ProcessEnv): MatrixTopologyStringSources {
  return {
    homeserver: readEnvMatrixString(env, "MATRIX_HOMESERVER"),
    userId: readEnvMatrixString(env, "MATRIX_USER_ID"),
    accessToken: readEnvMatrixString(env, "MATRIX_ACCESS_TOKEN"),
    password: readEnvMatrixString(env, "MATRIX_PASSWORD"),
    deviceId: readEnvMatrixString(env, "MATRIX_DEVICE_ID"),
    deviceName: readEnvMatrixString(env, "MATRIX_DEVICE_NAME"),
  };
}

function hasUsableResolvedMatrixAuth(values: {
  homeserver: string;
  userId: string;
  accessToken: string;
}): boolean {
  // Account discovery must keep homeserver+userId shapes because auth can still
  // resolve through cached Matrix credentials even when no fresh token/password
  // is present in config or env.
  return Boolean(values.homeserver && (values.accessToken || values.userId));
}

function hasFreshResolvedMatrixAuth(values: {
  homeserver: string;
  userId: string;
  accessToken: string;
  password: string;
}): boolean {
  return Boolean(values.homeserver && (values.accessToken || (values.userId && values.password)));
}

function resolveEffectiveMatrixAccountSources(params: {
  channel: Record<string, unknown> | null;
  accountId: string;
  env: NodeJS.ProcessEnv;
}): ReturnType<typeof resolveMatrixAccountStringValues> {
  const normalizedAccountId = normalizeAccountId(params.accountId);
  return resolveMatrixAccountStringValues({
    accountId: normalizedAccountId,
    scopedEnv: resolveScopedMatrixEnvStringSources(normalizedAccountId, params.env),
    channel: resolveMatrixChannelStringSources(params.channel),
    globalEnv: resolveGlobalMatrixEnvStringSources(params.env),
  });
}

function hasUsableEffectiveMatrixAccountSource(params: {
  channel: Record<string, unknown> | null;
  accountId: string;
  env: NodeJS.ProcessEnv;
}): boolean {
  return hasUsableResolvedMatrixAuth(resolveEffectiveMatrixAccountSources(params));
}

function hasFreshEffectiveMatrixAccountSource(params: {
  channel: Record<string, unknown> | null;
  accountId: string;
  env: NodeJS.ProcessEnv;
}): boolean {
  return hasFreshResolvedMatrixAuth(resolveEffectiveMatrixAccountSources(params));
}

function hasConfiguredDefaultMatrixAccountSource(params: {
  channel: Record<string, unknown> | null;
  env: NodeJS.ProcessEnv;
}): boolean {
  return hasFreshEffectiveMatrixAccountSource({
    channel: params.channel,
    accountId: DEFAULT_ACCOUNT_ID,
    env: params.env,
  });
}

export function resolveMatrixChannelConfig(cfg: OpenClawConfig): Record<string, unknown> | null {
  return isRecord(cfg.channels?.matrix) ? cfg.channels.matrix : null;
}

export function findMatrixAccountEntry(
  cfg: OpenClawConfig,
  accountId: string,
): Record<string, unknown> | null {
  const channel = resolveMatrixChannelConfig(cfg);
  if (!channel) {
    return null;
  }

  const accounts = isRecord(channel.accounts) ? channel.accounts : null;
  if (!accounts) {
    return null;
  }
  const entry = resolveNormalizedAccountEntry(accounts, accountId, normalizeAccountId);
  return isRecord(entry) ? entry : null;
}

export function resolveConfiguredMatrixAccountIds(
  cfg: OpenClawConfig,
  env: NodeJS.ProcessEnv = process.env,
): string[] {
  const channel = resolveMatrixChannelConfig(cfg);
  const configuredAccountIds = listConfiguredAccountIds({
    accounts: channel && isRecord(channel.accounts) ? channel.accounts : undefined,
    normalizeAccountId,
  });
  if (hasConfiguredDefaultMatrixAccountSource({ channel, env })) {
    configuredAccountIds.push(DEFAULT_ACCOUNT_ID);
  }
  const readyEnvAccountIds = listMatrixEnvAccountIds(env).filter((accountId) =>
    normalizeAccountId(accountId) === DEFAULT_ACCOUNT_ID
      ? hasConfiguredDefaultMatrixAccountSource({ channel, env })
      : hasUsableEffectiveMatrixAccountSource({ channel, accountId, env }),
  );
  return listCombinedAccountIds({
    configuredAccountIds,
    additionalAccountIds: readyEnvAccountIds,
    fallbackAccountIdWhenEmpty: channel ? DEFAULT_ACCOUNT_ID : undefined,
  });
}

export function resolveMatrixDefaultOrOnlyAccountId(
  cfg: OpenClawConfig,
  env: NodeJS.ProcessEnv = process.env,
): string {
  const channel = resolveMatrixChannelConfig(cfg);
  if (!channel) {
    return DEFAULT_ACCOUNT_ID;
  }

  const configuredDefault = normalizeOptionalAccountId(
    typeof channel.defaultAccount === "string" ? channel.defaultAccount : undefined,
  );
  const configuredAccountIds = resolveConfiguredMatrixAccountIds(cfg, env);
  return resolveListedDefaultAccountId({
    accountIds: configuredAccountIds,
    configuredDefaultAccountId: configuredDefault,
    ambiguousFallbackAccountId: DEFAULT_ACCOUNT_ID,
  });
}

export function requiresExplicitMatrixDefaultAccount(
  cfg: OpenClawConfig,
  env: NodeJS.ProcessEnv = process.env,
): boolean {
  const channel = resolveMatrixChannelConfig(cfg);
  if (!channel) {
    return false;
  }
  const configuredAccountIds = resolveConfiguredMatrixAccountIds(cfg, env);
  if (configuredAccountIds.length <= 1) {
    return false;
  }
  const configuredDefault = normalizeOptionalAccountId(
    typeof channel.defaultAccount === "string" ? channel.defaultAccount : undefined,
  );
  return !(configuredDefault && configuredAccountIds.includes(configuredDefault));
}