mirror of
https://github.com/openclaw/openclaw.git
synced 2026-06-23 12:48:10 +00:00
* docs: document markdown marker renderer * docs: document rendered markdown chunking * docs: document markdown text chunking * docs: document shared text chunking * docs: document plugin text chunking exports * docs: document avatar policy constants * docs: document node match candidates * docs: document scoped expiring id cache * docs: document runtime import normalization * docs: document string sample summaries * docs: document session usage timeseries types * docs: document session usage response types * docs: document manifest frontmatter shapes * docs: document channel route input metadata * docs: document pair loop guard settings * docs: document migration config patch helpers * docs: document api provider registry * docs: document tool call repair payloads * docs: document plugin tool payload helpers * docs: document lazy promise loader * docs: document store writer queue state * docs: document thread binding lifecycle * docs: document concurrency helper contract * docs: document gateway client info contract * docs: document delivery context contracts * docs: document secret ref defaults contract * docs: document command gating contract * docs: document avatar policy contract * docs: document node match policy * docs: document message channel normalization * docs: document boolean parsing contract * docs: document zod parse helpers * docs: document direct dm guard policy * docs: document fixed window limiter contract * docs: document node presence event contract * docs: document secret normalization contract * docs: document progress draft line removal * docs: document usage formatting contracts * docs: document agent run status contract * docs: document runtime import helpers * docs: document provider utility ownership * docs: document invalid config helpers * docs: document json compat parser * docs: document channel config metadata ownership * docs: document channel logging helpers * docs: document sender identity validation ownership * docs: document string sampling helper * docs: document global singleton helpers * docs: document transcript tool helpers * docs: document exec safe-bin normalization * docs: document reaction level resolver * docs: document account snapshot redaction boundary * docs: document messaging target helpers * docs: document thread binding messages * docs: document conversation binding context * docs: document conversation resolution helper * docs: document owner display secret retention * docs: document provider request config types * docs: document skills config types * docs: document memory config types * docs: document imessage config types * docs: document crestodian config types * docs: document tools config policies * docs: document shared config base types * docs: document channel config contracts * docs: document openclaw config state types * docs: document model config contracts * docs: document shared agent config types * docs: document agent defaults config types * docs: document secret input contracts * docs: document auth config contracts * docs: document gateway config contracts * docs: document tool call stream repair contracts * docs: document memory host facades * docs: document llm core contracts * docs: document markdown core contracts * docs: document gateway connect error contracts * docs: document gateway protocol primitives * docs: document gateway frame schemas * docs: document gateway device schemas * docs: document gateway environment schemas * docs: document gateway push schemas * docs: document gateway plugin schemas * docs: document gateway artifact schemas * docs: document gateway command schemas * docs: document gateway task schemas * docs: document gateway exec approval schemas * docs: document gateway secret schemas * docs: document gateway config schemas * docs: document gateway snapshot schemas * docs: document gateway chat schemas * docs: document gateway wizard schemas * docs: document gateway node schemas * docs: document gateway plugin approval schemas * docs: document gateway talk schemas * docs: document gateway agent schemas * docs: document gateway session schemas * docs: document gateway cron schemas * docs: document gateway agent model skill schemas * docs: document gateway skill proposal tool schemas * docs: document gateway protocol registry * docs: document gateway channel status schemas * docs: document gateway schema regression tests * docs: document gateway schema barrel * docs: document gateway validator tests * docs: document gateway primitive push tests * docs: document gateway contract tests * docs: document native protocol guard * docs: document channel schema tests * docs: document gateway protocol smoke tests * docs: document gateway protocol entrypoint * docs: document gateway protocol type exports * docs: document gateway error codes * docs: document protocol schema registry * docs: document talk audio codec * docs: document talk activation names * docs: document talk consult questions * docs: document talk consult tool * docs: document talk run control contracts * docs: document talk run control adapter * docs: document talkback consult queue * docs: document talk consult transcript guard * docs: document talk fast context runtime * docs: document forced talk consult coordinator * docs: document talk output activity tracker * docs: document talk event metrics * docs: document talk diagnostics * docs: document talk observability hook * docs: document talk provider resolver * docs: document talk provider registry * docs: document talk runtime primitives * docs: document talk consult controller logs * docs: document channel identity helpers * docs: document channel account allowlist helpers * docs: document channel metadata draft controls * docs: document channel ingress policy * docs: document channel sender access gates * docs: document channel catalog message contracts * docs: document channel account plugin helpers * docs: document configured binding helpers * docs: document channel acp approval config helpers * docs: document channel bundled config write helpers * docs: document channel plugin utility contracts * docs: document channel config access helpers * docs: document channel message action helpers * docs: document channel outbound runtime helpers * docs: document channel pairing promotion helpers * docs: document channel registry helpers * docs: document channel setup wizard helpers * docs: document channel lifecycle status helpers * docs: document channel target thread helpers * docs: document channel session binding helpers * docs: document channel package module probes * docs: document channel setup wizard contracts * docs: document channel plugin API barrels * docs: document channel contract test helpers * docs: document channel core helpers * docs: document small core facades * docs: document provider runtime helpers * docs: document persistence and realtime helpers * docs: document mcp and state helpers * docs: document tool planner contracts * docs: document music generation runtime * docs: document crestodian command flow * docs: document utility helpers * docs: document node host helpers * docs: document transcript contracts * docs: document trajectory export contracts * docs: document image generation contracts * docs: document routing helper contracts * docs: document session helper contracts * docs: document video generation contracts * docs: document model catalog contracts * docs: document proxy capture contracts * docs: document status rendering contracts * docs: document test helper contracts * docs: document wizard setup contracts * docs: document process contracts * docs: document memory host sdk contracts * docs: document tts contracts * docs: document secrets runtime contracts * docs: document shared helper contracts * docs: document hook runtime contracts * docs: document security audit contracts * docs: document flow contracts * docs: document media understanding contracts * docs: document tui contracts * docs: document logging contracts * docs: document llm contracts * docs: document cron contracts * docs: document daemon contracts * docs: document task contracts * docs: document acp contracts * docs: document test utility contracts * docs: document skill contracts * docs: document config contracts * docs: document outbound infra contracts * docs: document command analysis contracts * docs: document provider usage infra contracts * docs: document file safety infra contracts * docs: document exec approval infra contracts * docs: document gateway runtime infra contracts * docs: document infra utility contracts * docs: document infra queue storage contracts * docs: document heartbeat infra contracts * docs: document remaining infra contracts * docs: document gateway auth contracts * docs: document gateway display helpers * docs: document gateway http helpers * docs: document gateway node helpers * docs: document gateway mcp helpers * docs: document gateway support helpers * docs: document gateway server runtime helpers * docs: document gateway runtime bootstrap helpers * docs: document gateway session events * docs: document gateway utility helpers * docs: document gateway talk helpers * docs: document gateway helper contracts * docs: document gateway server method helpers * docs: document gateway server auth helpers * docs: document gateway server tests * docs: document gateway test helpers * docs: document gateway node tests * docs: document gateway channel tests * docs: document gateway session tests * docs: document gateway server startup tests * docs: document gateway tool test helpers * docs: document gateway server test helpers * docs: document gateway server method tests * docs: document remaining gateway tests * docs: document plugin sdk public subpaths * docs: document plugin sdk runtime helpers * docs: document plugin sdk memory provider helpers * docs: document plugin sdk runtime facades * docs: document plugin sdk command approval helpers * docs: document plugin sdk runtime types * docs: document plugin sdk browser account helpers * docs: document plugin sdk media memory helpers * docs: document plugin sdk core tests * docs: document plugin sdk contract helpers * docs: document plugin sdk test helpers * docs: document remaining plugin sdk tests * docs: document cli utility helpers * docs: document cli runtime helpers * docs: document cli command registration helpers * docs: document node cli helpers * docs: document cli program registration * docs: document message cli registration * docs: document daemon cli helpers * docs: document cli route parsers
672 lines
24 KiB
TypeScript
672 lines
24 KiB
TypeScript
import { normalizeOptionalLowercaseString } from "../../packages/normalization-core/src/string-coerce.js";
|
|
import { normalizeStringEntries } from "../../packages/normalization-core/src/string-normalization.js";
|
|
import {
|
|
deleteAccountFromConfigSection as deleteAccountFromConfigSectionInSection,
|
|
setAccountEnabledInConfigSection as setAccountEnabledInConfigSectionInSection,
|
|
} from "../channels/plugins/config-helpers.js";
|
|
import {
|
|
authorizeConfigWriteShared,
|
|
canBypassConfigWritePolicyShared,
|
|
formatConfigWriteDeniedMessageShared,
|
|
resolveChannelConfigWritesShared,
|
|
type ConfigWriteAuthorizationResultLike,
|
|
type ConfigWriteScopeLike,
|
|
type ConfigWriteTargetLike,
|
|
} from "../channels/plugins/config-write-policy-shared.js";
|
|
import { buildAccountScopedDmSecurityPolicy } from "../channels/plugins/helpers.js";
|
|
import type { ChannelConfigAdapter } from "../channels/plugins/types.adapters.js";
|
|
import type { OpenClawConfig } from "../config/types.openclaw.js";
|
|
import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "../routing/session-key.js";
|
|
|
|
export {
|
|
ensureOpenDmPolicyAllowFromWildcard,
|
|
normalizeChannelDmPolicy,
|
|
normalizeLegacyDmAliases,
|
|
resolveChannelDmAccess,
|
|
resolveChannelDmAllowFrom,
|
|
resolveChannelDmPolicy,
|
|
setCanonicalDmAllowFrom,
|
|
type ChannelDmAccess,
|
|
type ChannelDmAllowFromMode,
|
|
type ChannelDmPolicy,
|
|
type DmAccessRecord,
|
|
} from "../channels/plugins/dm-access.js";
|
|
|
|
const INTERNAL_MESSAGE_CHANNEL = "webchat";
|
|
|
|
/** Origin scope used when authorizing channel config writes. */
|
|
export type ConfigWriteScope = ConfigWriteScopeLike;
|
|
/** Target account/channel for a config write authorization check. */
|
|
export type ConfigWriteTarget = ConfigWriteTargetLike;
|
|
/** Decision returned by channel config write policy helpers. */
|
|
export type ConfigWriteAuthorizationResult = ConfigWriteAuthorizationResultLike;
|
|
|
|
type ChannelCrudConfigAdapter<ResolvedAccount> = Pick<
|
|
ChannelConfigAdapter<ResolvedAccount>,
|
|
| "listAccountIds"
|
|
| "resolveAccount"
|
|
| "inspectAccount"
|
|
| "defaultAccountId"
|
|
| "setAccountEnabled"
|
|
| "deleteAccount"
|
|
>;
|
|
|
|
type ChannelConfigAdapterWithAccessors<ResolvedAccount> = Pick<
|
|
ChannelConfigAdapter<ResolvedAccount>,
|
|
| "listAccountIds"
|
|
| "resolveAccount"
|
|
| "inspectAccount"
|
|
| "defaultAccountId"
|
|
| "setAccountEnabled"
|
|
| "deleteAccount"
|
|
| "resolveAllowFrom"
|
|
| "formatAllowFrom"
|
|
| "resolveDefaultTo"
|
|
>;
|
|
|
|
/** Returns whether config writes are enabled for a channel/account target. */
|
|
export function resolveChannelConfigWrites(params: {
|
|
cfg: OpenClawConfig;
|
|
channelId?: string | null;
|
|
accountId?: string | null;
|
|
}): boolean {
|
|
return resolveChannelConfigWritesShared(params);
|
|
}
|
|
|
|
/** Authorizes a channel config mutation against origin and target policy. */
|
|
export function authorizeConfigWrite(params: {
|
|
cfg: OpenClawConfig;
|
|
origin?: ConfigWriteScope;
|
|
target?: ConfigWriteTarget;
|
|
allowBypass?: boolean;
|
|
}): ConfigWriteAuthorizationResult {
|
|
return authorizeConfigWriteShared(params);
|
|
}
|
|
|
|
/** Returns true when trusted internal message scopes can bypass config write policy. */
|
|
export function canBypassConfigWritePolicy(params: {
|
|
channel?: string | null;
|
|
gatewayClientScopes?: string[] | null;
|
|
}): boolean {
|
|
return canBypassConfigWritePolicyShared({
|
|
...params,
|
|
isInternalMessageChannel: (channel) =>
|
|
normalizeOptionalLowercaseString(channel) === INTERNAL_MESSAGE_CHANNEL,
|
|
});
|
|
}
|
|
|
|
/** Formats the denial message shown when config write authorization fails. */
|
|
export function formatConfigWriteDeniedMessage(params: {
|
|
result: Exclude<ConfigWriteAuthorizationResult, { allowed: true }>;
|
|
fallbackChannelId?: string | null;
|
|
}): string {
|
|
return formatConfigWriteDeniedMessageShared(params);
|
|
}
|
|
|
|
type ChannelConfigAccessorParams<Config extends OpenClawConfig = OpenClawConfig> = {
|
|
cfg: Config;
|
|
accountId?: string | null;
|
|
};
|
|
|
|
type MultiAccountChannelConfigAdapterParams<
|
|
ResolvedAccount,
|
|
AccessorAccount = ResolvedAccount,
|
|
Config extends OpenClawConfig = OpenClawConfig,
|
|
> = {
|
|
sectionKey: string;
|
|
listAccountIds: (cfg: Config) => string[];
|
|
resolveAccount: (cfg: Config, accountId?: string | null) => ResolvedAccount;
|
|
resolveAccessorAccount?: (params: ChannelConfigAccessorParams<Config>) => AccessorAccount;
|
|
defaultAccountId: (cfg: Config) => string;
|
|
inspectAccount?: (cfg: Config, accountId?: string | null) => unknown;
|
|
clearBaseFields: string[];
|
|
resolveAllowFrom: (account: AccessorAccount) => Array<string | number> | null | undefined;
|
|
formatAllowFrom: (allowFrom: Array<string | number>) => string[];
|
|
resolveDefaultTo?: (account: AccessorAccount) => string | number | null | undefined;
|
|
};
|
|
|
|
type NamedAccountChannelConfigBaseParams<
|
|
ResolvedAccount,
|
|
Config extends OpenClawConfig = OpenClawConfig,
|
|
> = {
|
|
sectionKey: string;
|
|
listAccountIds: (cfg: Config) => string[];
|
|
resolveAccount: (cfg: Config, accountId?: string | null) => ResolvedAccount;
|
|
defaultAccountId: (cfg: Config) => string;
|
|
inspectAccount?: (cfg: Config, accountId?: string | null) => unknown;
|
|
clearBaseFields: string[];
|
|
};
|
|
|
|
/** Coerce mixed allowlist config values into plain strings without trimming or deduping. */
|
|
export function mapAllowFromEntries(
|
|
allowFrom: Array<string | number> | null | undefined,
|
|
): string[] {
|
|
return (allowFrom ?? []).map((entry) => String(entry));
|
|
}
|
|
|
|
/** Normalize user-facing allowlist entries the same way config and doctor flows expect. */
|
|
export function formatTrimmedAllowFromEntries(allowFrom: Array<string | number>): string[] {
|
|
return normalizeStringEntries(allowFrom);
|
|
}
|
|
|
|
/** Collapse nullable config scalars into a trimmed optional string. */
|
|
export function resolveOptionalConfigString(
|
|
value: string | number | null | undefined,
|
|
): string | undefined {
|
|
if (value == null) {
|
|
return undefined;
|
|
}
|
|
const normalized = String(value).trim();
|
|
return normalized || undefined;
|
|
}
|
|
|
|
/** Adapt `{ cfg, accountId }` accessors to callback sites that pass positional args. */
|
|
export function adaptScopedAccountAccessor<Result, Config extends OpenClawConfig = OpenClawConfig>(
|
|
accessor: (params: { cfg: Config; accountId?: string | null }) => Result,
|
|
): (cfg: Config, accountId?: string | null) => Result {
|
|
return (cfg, accountId) => accessor({ cfg, accountId });
|
|
}
|
|
|
|
/** Build the shared allowlist/default target adapter surface for account-scoped channel configs. */
|
|
export function createScopedAccountConfigAccessors<
|
|
ResolvedAccount,
|
|
// oxlint-disable-next-line typescript/no-unnecessary-type-parameters -- Config preserves caller-specific config subtype for account resolvers.
|
|
Config extends OpenClawConfig = OpenClawConfig,
|
|
>(params: {
|
|
/** Resolves the account used by read-only config accessors from `{ cfg, accountId }`. */
|
|
resolveAccount: (params: { cfg: Config; accountId?: string | null }) => ResolvedAccount;
|
|
/** Reads raw allowlist entries from the resolved account. */
|
|
resolveAllowFrom: (account: ResolvedAccount) => Array<string | number> | null | undefined;
|
|
/** Formats allowlist entries for display or config inspection. */
|
|
formatAllowFrom: (allowFrom: Array<string | number>) => string[];
|
|
/** Optional default destination selector; omitted when the channel has no default target. */
|
|
resolveDefaultTo?: (account: ResolvedAccount) => string | number | null | undefined;
|
|
}): Pick<
|
|
ChannelConfigAdapter<ResolvedAccount>,
|
|
"resolveAllowFrom" | "formatAllowFrom" | "resolveDefaultTo"
|
|
> {
|
|
const base = {
|
|
resolveAllowFrom({ cfg, accountId }: { cfg: OpenClawConfig; accountId?: string | null }) {
|
|
return mapAllowFromEntries(
|
|
params.resolveAllowFrom(params.resolveAccount({ cfg: cfg as Config, accountId })),
|
|
);
|
|
},
|
|
formatAllowFrom({ allowFrom }: { allowFrom: Array<string | number> }) {
|
|
return params.formatAllowFrom(allowFrom);
|
|
},
|
|
};
|
|
|
|
if (!params.resolveDefaultTo) {
|
|
return base;
|
|
}
|
|
|
|
return {
|
|
...base,
|
|
resolveDefaultTo({ cfg, accountId }) {
|
|
return resolveOptionalConfigString(
|
|
params.resolveDefaultTo?.(params.resolveAccount({ cfg: cfg as Config, accountId })),
|
|
);
|
|
},
|
|
};
|
|
}
|
|
|
|
function createNamedAccountConfigBase<
|
|
ResolvedAccount,
|
|
Config extends OpenClawConfig = OpenClawConfig,
|
|
>(params: {
|
|
listAccountIds: (cfg: Config) => string[];
|
|
resolveAccount: (cfg: Config, accountId?: string | null) => ResolvedAccount;
|
|
inspectAccount?: (cfg: Config, accountId?: string | null) => unknown;
|
|
defaultAccountId: (cfg: Config) => string;
|
|
setAccountEnabled: (params: {
|
|
cfg: OpenClawConfig;
|
|
accountId: string;
|
|
enabled: boolean;
|
|
}) => OpenClawConfig;
|
|
deleteAccount: (params: { cfg: OpenClawConfig; accountId: string }) => OpenClawConfig;
|
|
}): ChannelCrudConfigAdapter<ResolvedAccount> {
|
|
return {
|
|
listAccountIds(cfg) {
|
|
return params.listAccountIds(cfg as Config);
|
|
},
|
|
resolveAccount(cfg, accountId) {
|
|
return params.resolveAccount(cfg as Config, accountId);
|
|
},
|
|
inspectAccount: params.inspectAccount
|
|
? (cfg, accountId) => params.inspectAccount?.(cfg as Config, accountId)
|
|
: undefined,
|
|
defaultAccountId(cfg) {
|
|
return params.defaultAccountId(cfg as Config);
|
|
},
|
|
setAccountEnabled({ cfg, accountId, enabled }) {
|
|
return params.setAccountEnabled({
|
|
cfg,
|
|
accountId: normalizeAccountId(accountId),
|
|
enabled,
|
|
}) as Config;
|
|
},
|
|
deleteAccount({ cfg, accountId }) {
|
|
return params.deleteAccount({
|
|
cfg,
|
|
accountId: normalizeAccountId(accountId),
|
|
}) as Config;
|
|
},
|
|
};
|
|
}
|
|
|
|
function resolveAccessorAccountWithFallback<
|
|
AccessorAccount,
|
|
Config extends OpenClawConfig = OpenClawConfig,
|
|
>(
|
|
resolveAccessorAccount:
|
|
| ((params: ChannelConfigAccessorParams<Config>) => AccessorAccount)
|
|
| undefined,
|
|
fallbackResolveAccessorAccount: (params: ChannelConfigAccessorParams<Config>) => AccessorAccount,
|
|
): (params: ChannelConfigAccessorParams<Config>) => AccessorAccount {
|
|
// Read-only accessors can use a lighter account projection than runtime setup;
|
|
// fall back to the runtime resolver only when the channel has no projection hook.
|
|
return resolveAccessorAccount ?? fallbackResolveAccessorAccount;
|
|
}
|
|
|
|
function createChannelConfigAdapterWithAccessors<
|
|
ResolvedAccount,
|
|
AccessorAccount,
|
|
Config extends OpenClawConfig = OpenClawConfig,
|
|
>(params: {
|
|
base: ChannelCrudConfigAdapter<ResolvedAccount>;
|
|
resolveAccessorAccount?: (params: ChannelConfigAccessorParams<Config>) => AccessorAccount;
|
|
fallbackResolveAccessorAccount: (params: ChannelConfigAccessorParams<Config>) => AccessorAccount;
|
|
resolveAllowFrom: (account: AccessorAccount) => Array<string | number> | null | undefined;
|
|
formatAllowFrom: (allowFrom: Array<string | number>) => string[];
|
|
resolveDefaultTo?: (account: AccessorAccount) => string | number | null | undefined;
|
|
}): ChannelConfigAdapterWithAccessors<ResolvedAccount> {
|
|
return {
|
|
...params.base,
|
|
...createScopedAccountConfigAccessors<AccessorAccount, Config>({
|
|
resolveAccount: resolveAccessorAccountWithFallback(
|
|
params.resolveAccessorAccount,
|
|
params.fallbackResolveAccessorAccount,
|
|
),
|
|
resolveAllowFrom: params.resolveAllowFrom,
|
|
formatAllowFrom: params.formatAllowFrom,
|
|
resolveDefaultTo: params.resolveDefaultTo,
|
|
}),
|
|
};
|
|
}
|
|
|
|
function createChannelConfigAdapterFromBase<
|
|
ResolvedAccount,
|
|
AccessorAccount,
|
|
Config extends OpenClawConfig = OpenClawConfig,
|
|
>(params: {
|
|
base: ChannelCrudConfigAdapter<ResolvedAccount>;
|
|
resolveAccessorAccount?: (params: ChannelConfigAccessorParams<Config>) => AccessorAccount;
|
|
resolveAccountForAccessors: (params: ChannelConfigAccessorParams<Config>) => AccessorAccount;
|
|
resolveAllowFrom: (account: AccessorAccount) => Array<string | number> | null | undefined;
|
|
formatAllowFrom: (allowFrom: Array<string | number>) => string[];
|
|
resolveDefaultTo?: (account: AccessorAccount) => string | number | null | undefined;
|
|
}): ChannelConfigAdapterWithAccessors<ResolvedAccount> {
|
|
return createChannelConfigAdapterWithAccessors<ResolvedAccount, AccessorAccount, Config>({
|
|
base: params.base,
|
|
resolveAccessorAccount: params.resolveAccessorAccount,
|
|
fallbackResolveAccessorAccount: params.resolveAccountForAccessors,
|
|
resolveAllowFrom: params.resolveAllowFrom,
|
|
formatAllowFrom: params.formatAllowFrom,
|
|
resolveDefaultTo: params.resolveDefaultTo,
|
|
});
|
|
}
|
|
|
|
/** Build the common CRUD/config helpers for channels that store multiple named accounts. */
|
|
export function createScopedChannelConfigBase<
|
|
ResolvedAccount,
|
|
Config extends OpenClawConfig = OpenClawConfig,
|
|
>(
|
|
params: NamedAccountChannelConfigBaseParams<ResolvedAccount, Config> & {
|
|
allowTopLevel?: boolean;
|
|
},
|
|
): ChannelCrudConfigAdapter<ResolvedAccount> {
|
|
return createNamedAccountConfigBase<ResolvedAccount, Config>({
|
|
listAccountIds: params.listAccountIds,
|
|
resolveAccount: params.resolveAccount,
|
|
inspectAccount: params.inspectAccount,
|
|
defaultAccountId: params.defaultAccountId,
|
|
setAccountEnabled({ cfg, accountId, enabled }) {
|
|
return setAccountEnabledInConfigSectionInSection({
|
|
cfg,
|
|
sectionKey: params.sectionKey,
|
|
accountId,
|
|
enabled,
|
|
allowTopLevel: params.allowTopLevel ?? true,
|
|
});
|
|
},
|
|
deleteAccount({ cfg, accountId }) {
|
|
return deleteAccountFromConfigSectionInSection({
|
|
cfg,
|
|
sectionKey: params.sectionKey,
|
|
accountId,
|
|
clearBaseFields: params.clearBaseFields,
|
|
});
|
|
},
|
|
});
|
|
}
|
|
|
|
/** Build the full shared config adapter for account-scoped channels with allowlist/default target accessors. */
|
|
export function createScopedChannelConfigAdapter<
|
|
ResolvedAccount,
|
|
AccessorAccount = ResolvedAccount,
|
|
Config extends OpenClawConfig = OpenClawConfig,
|
|
>(
|
|
params: MultiAccountChannelConfigAdapterParams<ResolvedAccount, AccessorAccount, Config> & {
|
|
allowTopLevel?: boolean;
|
|
},
|
|
): ChannelConfigAdapterWithAccessors<ResolvedAccount> {
|
|
return createChannelConfigAdapterFromBase<ResolvedAccount, AccessorAccount, Config>({
|
|
base: createScopedChannelConfigBase<ResolvedAccount, Config>({
|
|
sectionKey: params.sectionKey,
|
|
listAccountIds: params.listAccountIds,
|
|
resolveAccount: params.resolveAccount,
|
|
inspectAccount: params.inspectAccount,
|
|
defaultAccountId: params.defaultAccountId,
|
|
clearBaseFields: params.clearBaseFields,
|
|
allowTopLevel: params.allowTopLevel,
|
|
}),
|
|
resolveAccessorAccount: params.resolveAccessorAccount,
|
|
resolveAccountForAccessors({ cfg, accountId }) {
|
|
return params.resolveAccount(cfg, accountId) as unknown as AccessorAccount;
|
|
},
|
|
resolveAllowFrom: params.resolveAllowFrom,
|
|
formatAllowFrom: params.formatAllowFrom,
|
|
resolveDefaultTo: params.resolveDefaultTo,
|
|
});
|
|
}
|
|
|
|
function setTopLevelChannelEnabledInConfigSection<Config extends OpenClawConfig>(params: {
|
|
cfg: Config;
|
|
sectionKey: string;
|
|
enabled: boolean;
|
|
}): Config {
|
|
const section = params.cfg.channels?.[params.sectionKey] as Record<string, unknown> | undefined;
|
|
return {
|
|
...params.cfg,
|
|
channels: {
|
|
...params.cfg.channels,
|
|
[params.sectionKey]: {
|
|
...section,
|
|
enabled: params.enabled,
|
|
},
|
|
},
|
|
} as Config;
|
|
}
|
|
|
|
function removeTopLevelChannelConfigSection<Config extends OpenClawConfig>(params: {
|
|
cfg: Config;
|
|
sectionKey: string;
|
|
}): Config {
|
|
const nextChannels = { ...params.cfg.channels } as Record<string, unknown>;
|
|
delete nextChannels[params.sectionKey];
|
|
const nextCfg = { ...params.cfg };
|
|
if (Object.keys(nextChannels).length > 0) {
|
|
nextCfg.channels = nextChannels as Config["channels"];
|
|
} else {
|
|
delete nextCfg.channels;
|
|
}
|
|
return nextCfg;
|
|
}
|
|
|
|
function clearTopLevelChannelConfigFields<Config extends OpenClawConfig>(params: {
|
|
cfg: Config;
|
|
sectionKey: string;
|
|
clearBaseFields: string[];
|
|
}): Config {
|
|
const section = params.cfg.channels?.[params.sectionKey] as Record<string, unknown> | undefined;
|
|
if (!section) {
|
|
return params.cfg;
|
|
}
|
|
const nextSection = { ...section };
|
|
for (const field of params.clearBaseFields) {
|
|
delete nextSection[field];
|
|
}
|
|
return {
|
|
...params.cfg,
|
|
channels: {
|
|
...params.cfg.channels,
|
|
[params.sectionKey]: nextSection,
|
|
},
|
|
} as Config;
|
|
}
|
|
|
|
/** Build CRUD/config helpers for top-level single-account channels. */
|
|
export function createTopLevelChannelConfigBase<
|
|
ResolvedAccount,
|
|
Config extends OpenClawConfig = OpenClawConfig,
|
|
>(params: {
|
|
sectionKey: string;
|
|
resolveAccount: (cfg: Config) => ResolvedAccount;
|
|
listAccountIds?: (cfg: Config) => string[];
|
|
defaultAccountId?: (cfg: Config) => string;
|
|
inspectAccount?: (cfg: Config) => unknown;
|
|
deleteMode?: "remove-section" | "clear-fields";
|
|
clearBaseFields?: string[];
|
|
}): Pick<
|
|
ChannelConfigAdapter<ResolvedAccount>,
|
|
| "listAccountIds"
|
|
| "resolveAccount"
|
|
| "inspectAccount"
|
|
| "defaultAccountId"
|
|
| "setAccountEnabled"
|
|
| "deleteAccount"
|
|
> {
|
|
return {
|
|
listAccountIds(cfg) {
|
|
return params.listAccountIds?.(cfg as Config) ?? [DEFAULT_ACCOUNT_ID];
|
|
},
|
|
resolveAccount(cfg) {
|
|
return params.resolveAccount(cfg as Config);
|
|
},
|
|
inspectAccount: params.inspectAccount
|
|
? (cfg) => params.inspectAccount?.(cfg as Config)
|
|
: undefined,
|
|
defaultAccountId(cfg) {
|
|
return params.defaultAccountId?.(cfg as Config) ?? DEFAULT_ACCOUNT_ID;
|
|
},
|
|
setAccountEnabled({ cfg, enabled }) {
|
|
return setTopLevelChannelEnabledInConfigSection({
|
|
cfg: cfg as Config,
|
|
sectionKey: params.sectionKey,
|
|
enabled,
|
|
});
|
|
},
|
|
deleteAccount({ cfg }) {
|
|
return params.deleteMode === "clear-fields"
|
|
? clearTopLevelChannelConfigFields({
|
|
cfg: cfg as Config,
|
|
sectionKey: params.sectionKey,
|
|
clearBaseFields: params.clearBaseFields ?? [],
|
|
})
|
|
: removeTopLevelChannelConfigSection({
|
|
cfg: cfg as Config,
|
|
sectionKey: params.sectionKey,
|
|
});
|
|
},
|
|
};
|
|
}
|
|
|
|
/** Build the full shared config adapter for top-level single-account channels with allowlist/default target accessors. */
|
|
export function createTopLevelChannelConfigAdapter<
|
|
ResolvedAccount,
|
|
AccessorAccount = ResolvedAccount,
|
|
Config extends OpenClawConfig = OpenClawConfig,
|
|
>(params: {
|
|
sectionKey: string;
|
|
resolveAccount: (cfg: Config) => ResolvedAccount;
|
|
resolveAccessorAccount?: (params: { cfg: Config; accountId?: string | null }) => AccessorAccount;
|
|
listAccountIds?: (cfg: Config) => string[];
|
|
defaultAccountId?: (cfg: Config) => string;
|
|
inspectAccount?: (cfg: Config) => unknown;
|
|
deleteMode?: "remove-section" | "clear-fields";
|
|
clearBaseFields?: string[];
|
|
resolveAllowFrom: (account: AccessorAccount) => Array<string | number> | null | undefined;
|
|
formatAllowFrom: (allowFrom: Array<string | number>) => string[];
|
|
resolveDefaultTo?: (account: AccessorAccount) => string | number | null | undefined;
|
|
}): ChannelConfigAdapterWithAccessors<ResolvedAccount> {
|
|
return createChannelConfigAdapterFromBase<ResolvedAccount, AccessorAccount, Config>({
|
|
base: createTopLevelChannelConfigBase<ResolvedAccount, Config>({
|
|
sectionKey: params.sectionKey,
|
|
resolveAccount: params.resolveAccount,
|
|
listAccountIds: params.listAccountIds,
|
|
defaultAccountId: params.defaultAccountId,
|
|
inspectAccount: params.inspectAccount,
|
|
deleteMode: params.deleteMode,
|
|
clearBaseFields: params.clearBaseFields,
|
|
}),
|
|
resolveAccessorAccount: params.resolveAccessorAccount,
|
|
resolveAccountForAccessors({ cfg }) {
|
|
return params.resolveAccount(cfg) as unknown as AccessorAccount;
|
|
},
|
|
resolveAllowFrom: params.resolveAllowFrom,
|
|
formatAllowFrom: params.formatAllowFrom,
|
|
resolveDefaultTo: params.resolveDefaultTo,
|
|
});
|
|
}
|
|
|
|
/** Build CRUD/config helpers for channels where the default account lives at channel root and named accounts live under `accounts`. */
|
|
export function createHybridChannelConfigBase<
|
|
ResolvedAccount,
|
|
Config extends OpenClawConfig = OpenClawConfig,
|
|
>(
|
|
params: NamedAccountChannelConfigBaseParams<ResolvedAccount, Config> & {
|
|
preserveSectionOnDefaultDelete?: boolean;
|
|
},
|
|
): ChannelCrudConfigAdapter<ResolvedAccount> {
|
|
return createNamedAccountConfigBase<ResolvedAccount, Config>({
|
|
listAccountIds: params.listAccountIds,
|
|
resolveAccount: params.resolveAccount,
|
|
inspectAccount: params.inspectAccount,
|
|
defaultAccountId: params.defaultAccountId,
|
|
setAccountEnabled({ cfg, accountId, enabled }) {
|
|
if (normalizeAccountId(accountId) === DEFAULT_ACCOUNT_ID) {
|
|
return setTopLevelChannelEnabledInConfigSection({
|
|
cfg,
|
|
sectionKey: params.sectionKey,
|
|
enabled,
|
|
});
|
|
}
|
|
return setAccountEnabledInConfigSectionInSection({
|
|
cfg,
|
|
sectionKey: params.sectionKey,
|
|
accountId,
|
|
enabled,
|
|
});
|
|
},
|
|
deleteAccount({ cfg, accountId }) {
|
|
if (normalizeAccountId(accountId) === DEFAULT_ACCOUNT_ID) {
|
|
if (params.preserveSectionOnDefaultDelete) {
|
|
// Some hybrid channels keep non-account config at the root, so deleting
|
|
// default account credentials must clear only account-owned fields.
|
|
return clearTopLevelChannelConfigFields({
|
|
cfg,
|
|
sectionKey: params.sectionKey,
|
|
clearBaseFields: params.clearBaseFields,
|
|
});
|
|
}
|
|
return deleteAccountFromConfigSectionInSection({
|
|
cfg,
|
|
sectionKey: params.sectionKey,
|
|
accountId,
|
|
clearBaseFields: params.clearBaseFields,
|
|
});
|
|
}
|
|
return deleteAccountFromConfigSectionInSection({
|
|
cfg,
|
|
sectionKey: params.sectionKey,
|
|
accountId,
|
|
clearBaseFields: params.clearBaseFields,
|
|
});
|
|
},
|
|
});
|
|
}
|
|
|
|
/** Build the full shared config adapter for hybrid channels with allowlist/default target accessors. */
|
|
export function createHybridChannelConfigAdapter<
|
|
ResolvedAccount,
|
|
AccessorAccount = ResolvedAccount,
|
|
Config extends OpenClawConfig = OpenClawConfig,
|
|
>(
|
|
params: MultiAccountChannelConfigAdapterParams<ResolvedAccount, AccessorAccount, Config> & {
|
|
preserveSectionOnDefaultDelete?: boolean;
|
|
},
|
|
): ChannelConfigAdapterWithAccessors<ResolvedAccount> {
|
|
return createChannelConfigAdapterFromBase<ResolvedAccount, AccessorAccount, Config>({
|
|
base: createHybridChannelConfigBase<ResolvedAccount, Config>({
|
|
sectionKey: params.sectionKey,
|
|
listAccountIds: params.listAccountIds,
|
|
resolveAccount: params.resolveAccount,
|
|
inspectAccount: params.inspectAccount,
|
|
defaultAccountId: params.defaultAccountId,
|
|
clearBaseFields: params.clearBaseFields,
|
|
preserveSectionOnDefaultDelete: params.preserveSectionOnDefaultDelete,
|
|
}),
|
|
resolveAccessorAccount: params.resolveAccessorAccount,
|
|
resolveAccountForAccessors({ cfg, accountId }) {
|
|
return params.resolveAccount(cfg, accountId) as unknown as AccessorAccount;
|
|
},
|
|
resolveAllowFrom: params.resolveAllowFrom,
|
|
formatAllowFrom: params.formatAllowFrom,
|
|
resolveDefaultTo: params.resolveDefaultTo,
|
|
});
|
|
}
|
|
|
|
/** Convert account-specific DM security fields into the shared runtime policy resolver shape. */
|
|
export function createScopedDmSecurityResolver<
|
|
ResolvedAccount extends { accountId?: string | null },
|
|
>(params: {
|
|
channelKey: string;
|
|
resolvePolicy: (account: ResolvedAccount) => string | null | undefined;
|
|
resolveAllowFrom: (account: ResolvedAccount) => Array<string | number> | null | undefined;
|
|
resolveAccess?: (params: {
|
|
cfg: OpenClawConfig;
|
|
accountId?: string | null;
|
|
account: ResolvedAccount;
|
|
}) => {
|
|
dmPolicy?: string | null;
|
|
allowFrom?: Array<string | number> | null;
|
|
};
|
|
resolveFallbackAccountId?: (account: ResolvedAccount) => string | null | undefined;
|
|
defaultPolicy?: string;
|
|
allowFromPathSuffix?: string;
|
|
policyPathSuffix?: string;
|
|
approveChannelId?: string;
|
|
approveHint?: string;
|
|
normalizeEntry?: (raw: string) => string;
|
|
inheritSharedDefaultsFromDefaultAccount?: boolean;
|
|
}) {
|
|
return ({
|
|
cfg,
|
|
accountId,
|
|
account,
|
|
}: {
|
|
cfg: OpenClawConfig;
|
|
accountId?: string | null;
|
|
account: ResolvedAccount;
|
|
}) => {
|
|
const access = params.resolveAccess?.({ cfg, accountId, account });
|
|
return buildAccountScopedDmSecurityPolicy({
|
|
cfg,
|
|
channelKey: params.channelKey,
|
|
accountId,
|
|
fallbackAccountId: params.resolveFallbackAccountId?.(account) ?? account.accountId,
|
|
policy: access?.dmPolicy ?? params.resolvePolicy(account),
|
|
allowFrom: access?.allowFrom ?? params.resolveAllowFrom(account) ?? [],
|
|
defaultPolicy: params.defaultPolicy,
|
|
allowFromPathSuffix: params.allowFromPathSuffix,
|
|
policyPathSuffix: params.policyPathSuffix,
|
|
approveChannelId: params.approveChannelId,
|
|
approveHint: params.approveHint,
|
|
normalizeEntry: params.normalizeEntry,
|
|
inheritSharedDefaultsFromDefaultAccount: params.inheritSharedDefaultsFromDefaultAccount,
|
|
});
|
|
};
|
|
}
|
|
|
|
export { buildAccountScopedDmSecurityPolicy };
|