@elizaos/core 2.0.0-alpha.52 → 2.0.0-alpha.53

package/dist/types/onboarding.d.ts

@@ -0,0 +1,319 @@
+/**
+ * Onboarding Types
+ *
+ * Type definitions for the unified onboarding state machine that supports
+ * both CLI and conversational (DM) onboarding flows.
+ */
+import type { Metadata, UUID } from "./primitives";
+/**
+ * Onboarding step identifiers.
+ * These represent the discrete steps in the onboarding flow.
+ */
+export declare const OnboardingStep: {
+    /** Initial welcome and introduction */
+    readonly WELCOME: "WELCOME";
+    /** Risk acknowledgement - user must accept security warnings */
+    readonly RISK_ACK: "RISK_ACK";
+    /** Authentication setup - API keys, OAuth, etc. */
+    readonly AUTH: "AUTH";
+    /** Channel configuration - Discord, Telegram, etc. */
+    readonly CHANNELS: "CHANNELS";
+    /** Skills setup - tools and capabilities */
+    readonly SKILLS: "SKILLS";
+    /** Onboarding complete */
+    readonly COMPLETE: "COMPLETE";
+};
+export type OnboardingStep = (typeof OnboardingStep)[keyof typeof OnboardingStep];
+/**
+ * Ordered list of onboarding steps for progression.
+ */
+export declare const ONBOARDING_STEP_ORDER: OnboardingStep[];
+/**
+ * Settings collected during the AUTH step.
+ */
+export interface AuthSettings {
+    /** Primary model provider (anthropic, openai, google, etc.) */
+    modelProvider?: string;
+    /** API key for the selected provider */
+    apiKey?: string;
+    /** OAuth tokens if using OAuth flow */
+    oauthTokens?: {
+        accessToken: string;
+        refreshToken?: string;
+        expiresAt?: number;
+    };
+    /** Setup token (e.g., from `claude setup-token`) */
+    setupToken?: string;
+    /** Authentication method used */
+    authMethod?: "api_key" | "oauth" | "setup_token";
+}
+/**
+ * Settings collected during the CHANNELS step.
+ */
+export interface ChannelSettings {
+    /** Enabled channel types */
+    enabledChannels: string[];
+    /** Channel-specific configurations */
+    channelConfigs: Record<string, ChannelConfig>;
+    /** DM policy settings */
+    dmPolicy?: {
+        allowUnknownSenders?: boolean;
+        requireApproval?: boolean;
+    };
+}
+/**
+ * Configuration for a specific channel.
+ */
+export interface ChannelConfig {
+    /** Channel type (discord, telegram, etc.) */
+    type: string;
+    /** Whether the channel is enabled */
+    enabled: boolean;
+    /** Channel-specific credentials */
+    credentials?: Record<string, string>;
+    /** Additional channel settings */
+    settings?: Record<string, string | boolean | number>;
+}
+/**
+ * Settings collected during the SKILLS step.
+ */
+export interface SkillsSettings {
+    /** Enabled skills */
+    enabledSkills: string[];
+    /** Skills to install */
+    skillsToInstall: string[];
+    /** Homebrew installation preference */
+    useHomebrew?: boolean;
+    /** Node package manager preference */
+    nodeManager?: "npm" | "pnpm" | "bun";
+}
+/**
+ * Complete settings collected during onboarding.
+ */
+export interface OnboardingSettings {
+    /** Auth step settings */
+    auth?: AuthSettings;
+    /** Channels step settings */
+    channels?: ChannelSettings;
+    /** Skills step settings */
+    skills?: SkillsSettings;
+    /** Risk acknowledgement timestamp */
+    riskAcknowledgedAt?: number;
+    /** Whether user acknowledged risks */
+    riskAcknowledged?: boolean;
+    /** Gateway configuration */
+    gateway?: {
+        mode: "local" | "remote";
+        port?: number;
+        bind?: string;
+    };
+}
+/**
+ * Error information for a specific step.
+ */
+export interface OnboardingStepError {
+    /** Error code */
+    code: string;
+    /** Human-readable error message */
+    message: string;
+    /** Step where the error occurred */
+    step: OnboardingStep;
+    /** Additional error details */
+    details?: Record<string, unknown>;
+    /** Timestamp when error occurred */
+    timestamp: number;
+}
+/**
+ * Context tracking the current state of onboarding.
+ */
+export interface OnboardingContext {
+    /** Current onboarding step */
+    currentStep: OnboardingStep;
+    /** Steps that have been completed */
+    completedSteps: OnboardingStep[];
+    /** Collected settings */
+    settings: OnboardingSettings;
+    /** Errors encountered during onboarding */
+    errors: OnboardingStepError[];
+    /** When onboarding started */
+    startedAt: number;
+    /** Last activity timestamp */
+    lastActivityAt: number;
+    /** World ID (for DM onboarding) */
+    worldId?: UUID;
+    /** User ID being onboarded */
+    userId?: UUID;
+    /** Platform (discord, telegram, cli, etc.) */
+    platform: string;
+    /** Onboarding mode */
+    mode: "cli" | "conversational" | "wizard";
+    /** Session ID for tracking */
+    sessionId: string;
+    /** Whether onboarding was interrupted */
+    interrupted?: boolean;
+    /** Metadata for custom extensions */
+    metadata?: Metadata;
+}
+/**
+ * Input types for each onboarding step.
+ */
+export interface WelcomeInput {
+    /** User's response to welcome message */
+    acknowledged: boolean;
+    /** User's name (optional) */
+    userName?: string;
+}
+export interface RiskAckInput {
+    /** Whether user accepted the risk warning */
+    accepted: boolean;
+    /** Text of the warning that was shown */
+    warningText?: string;
+}
+export interface AuthInput {
+    /** Auth method being used */
+    method: "api_key" | "oauth" | "setup_token";
+    /** Provider name */
+    provider?: string;
+    /** API key if using api_key method */
+    apiKey?: string;
+    /** OAuth callback data if using oauth method */
+    oauthCallback?: {
+        code: string;
+        state: string;
+    };
+    /** Setup token if using setup_token method */
+    setupToken?: string;
+    /** Skip auth (use local models) */
+    skip?: boolean;
+}
+export interface ChannelsInput {
+    /** Channels to enable */
+    channels: Array<{
+        type: string;
+        enabled: boolean;
+        token?: string;
+        credentials?: Record<string, string>;
+        settings?: Record<string, string | boolean | number>;
+    }>;
+    /** DM policy configuration */
+    dmPolicy?: {
+        allowUnknownSenders?: boolean;
+        requireApproval?: boolean;
+    };
+    /** Skip channels configuration */
+    skip?: boolean;
+}
+export interface SkillsInput {
+    /** Skills to enable */
+    skills: string[];
+    /** Skills to install */
+    install: string[];
+    /** Installation preferences */
+    preferences?: {
+        useHomebrew?: boolean;
+        nodeManager?: "npm" | "pnpm" | "bun";
+    };
+    /** Skip skills configuration */
+    skip?: boolean;
+}
+/**
+ * Union type for step-specific inputs.
+ */
+export type OnboardingInput = {
+    step: typeof OnboardingStep.WELCOME;
+    data: WelcomeInput;
+} | {
+    step: typeof OnboardingStep.RISK_ACK;
+    data: RiskAckInput;
+} | {
+    step: typeof OnboardingStep.AUTH;
+    data: AuthInput;
+} | {
+    step: typeof OnboardingStep.CHANNELS;
+    data: ChannelsInput;
+} | {
+    step: typeof OnboardingStep.SKILLS;
+    data: SkillsInput;
+} | {
+    step: typeof OnboardingStep.COMPLETE;
+    data: Record<string, never>;
+};
+/**
+ * Result of advancing a step.
+ */
+export interface OnboardingResult {
+    /** Whether the step was successfully processed */
+    success: boolean;
+    /** The new current step after processing */
+    newStep: OnboardingStep;
+    /** Whether onboarding is now complete */
+    isComplete: boolean;
+    /** Error if the step failed */
+    error?: OnboardingStepError;
+    /** Message to display to the user */
+    message?: string;
+    /** Updated context */
+    context: OnboardingContext;
+    /** Data returned from the step (e.g., validation results) */
+    data?: Record<string, unknown>;
+}
+/**
+ * Progress information for display.
+ */
+export interface OnboardingProgress {
+    /** Current step number (1-indexed) */
+    currentStepNumber: number;
+    /** Total number of steps */
+    totalSteps: number;
+    /** Completion percentage (0-100) */
+    percentage: number;
+    /** List of step statuses */
+    steps: Array<{
+        step: OnboardingStep;
+        label: string;
+        status: "completed" | "current" | "pending" | "error";
+        errorMessage?: string;
+    }>;
+    /** Estimated time remaining (in seconds) */
+    estimatedTimeRemaining?: number;
+}
+/**
+ * Serialized onboarding state for persistence.
+ */
+export interface SerializedOnboardingState {
+    /** Version of the serialization format */
+    version: number;
+    /** The onboarding context */
+    context: OnboardingContext;
+    /** Checksum for integrity verification */
+    checksum?: string;
+}
+/**
+ * Labels for each onboarding step (for UI display).
+ */
+export declare const ONBOARDING_STEP_LABELS: Record<OnboardingStep, string>;
+/**
+ * Descriptions for each onboarding step.
+ */
+export declare const ONBOARDING_STEP_DESCRIPTIONS: Record<OnboardingStep, string>;
+/**
+ * Get the step index (0-indexed) for a given step.
+ */
+export declare function getStepIndex(step: OnboardingStep): number;
+/**
+ * Get the next step in the sequence, or null if at the end.
+ */
+export declare function getNextStep(currentStep: OnboardingStep): OnboardingStep | null;
+/**
+ * Get the previous step in the sequence, or null if at the beginning.
+ */
+export declare function getPreviousStep(currentStep: OnboardingStep): OnboardingStep | null;
+/**
+ * Check if a step has been completed in the given context.
+ */
+export declare function isStepCompleted(context: OnboardingContext, step: OnboardingStep): boolean;
+/**
+ * Calculate completion percentage from context.
+ */
+export declare function calculateProgress(context: OnboardingContext): number;
+//# sourceMappingURL=onboarding.d.ts.map

package/dist/types/onboarding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onboarding.d.ts","sourceRoot":"","sources":["../../src/types/onboarding.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,cAAc;IAC1B,uCAAuC;;IAEvC,gEAAgE;;IAEhE,mDAAmD;;IAEnD,sDAAsD;;IAEtD,4CAA4C;;IAE5C,0BAA0B;;CAEjB,CAAC;AAEX,MAAM,MAAM,cAAc,GACzB,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,cAAc,EAOjD,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,+DAA+D;IAC/D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,WAAW,CAAC,EAAE;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,SAAS,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,UAAU,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,aAAa,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B,4BAA4B;IAC5B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,sCAAsC;IACtC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC9C,yBAAyB;IACzB,QAAQ,CAAC,EAAE;QACV,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B,eAAe,CAAC,EAAE,OAAO,CAAC;KAC1B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,OAAO,EAAE,OAAO,CAAC;IACjB,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,qBAAqB;IACrB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,wBAAwB;IACxB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,uCAAuC;IACvC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,sCAAsC;IACtC,WAAW,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,yBAAyB;IACzB,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,2BAA2B;IAC3B,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,qCAAqC;IACrC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,sCAAsC;IACtC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,4BAA4B;IAC5B,OAAO,CAAC,EAAE;QACT,IAAI,EAAE,OAAO,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;CACF;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,IAAI,EAAE,cAAc,CAAC;IACrB,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC,8BAA8B;IAC9B,WAAW,EAAE,cAAc,CAAC;IAC5B,qCAAqC;IACrC,cAAc,EAAE,cAAc,EAAE,CAAC;IACjC,yBAAyB;IACzB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,2CAA2C;IAC3C,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAC9B,8BAA8B;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,mCAAmC;IACnC,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,8BAA8B;IAC9B,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,8CAA8C;IAC9C,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,IAAI,EAAE,KAAK,GAAG,gBAAgB,GAAG,QAAQ,CAAC;IAC1C,8BAA8B;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,qCAAqC;IACrC,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,yCAAyC;IACzC,YAAY,EAAE,OAAO,CAAC;IACtB,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC5B,6CAA6C;IAC7C,QAAQ,EAAE,OAAO,CAAC;IAClB,yCAAyC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,SAAS;IACzB,6BAA6B;IAC7B,MAAM,EAAE,SAAS,GAAG,OAAO,GAAG,aAAa,CAAC;IAC5C,oBAAoB;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gDAAgD;IAChD,aAAa,CAAC,EAAE;QACf,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACd,CAAC;IACF,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mCAAmC;IACnC,IAAI,CAAC,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC7B,yBAAyB;IACzB,QAAQ,EAAE,KAAK,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,OAAO,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACrC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC,CAAC;KACrD,CAAC,CAAC;IACH,8BAA8B;IAC9B,QAAQ,CAAC,EAAE;QACV,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B,eAAe,CAAC,EAAE,OAAO,CAAC;KAC1B,CAAC;IACF,kCAAkC;IAClC,IAAI,CAAC,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC3B,uBAAuB;IACvB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,wBAAwB;IACxB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,+BAA+B;IAC/B,WAAW,CAAC,EAAE;QACb,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,WAAW,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC;KACrC,CAAC;IACF,gCAAgC;IAChC,IAAI,CAAC,EAAE,OAAO,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GACxB;IAAE,IAAI,EAAE,OAAO,cAAc,CAAC,OAAO,CAAC;IAAC,IAAI,EAAE,YAAY,CAAA;CAAE,GAC3D;IAAE,IAAI,EAAE,OAAO,cAAc,CAAC,QAAQ,CAAC;IAAC,IAAI,EAAE,YAAY,CAAA;CAAE,GAC5D;IAAE,IAAI,EAAE,OAAO,cAAc,CAAC,IAAI,CAAC;IAAC,IAAI,EAAE,SAAS,CAAA;CAAE,GACrD;IAAE,IAAI,EAAE,OAAO,cAAc,CAAC,QAAQ,CAAC;IAAC,IAAI,EAAE,aAAa,CAAA;CAAE,GAC7D;IAAE,IAAI,EAAE,OAAO,cAAc,CAAC,MAAM,CAAC;IAAC,IAAI,EAAE,WAAW,CAAA;CAAE,GACzD;IAAE,IAAI,EAAE,OAAO,cAAc,CAAC,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;CAAE,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,kDAAkD;IAClD,OAAO,EAAE,OAAO,CAAC;IACjB,4CAA4C;IAC5C,OAAO,EAAE,cAAc,CAAC;IACxB,yCAAyC;IACzC,UAAU,EAAE,OAAO,CAAC;IACpB,+BAA+B;IAC/B,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,OAAO,EAAE,iBAAiB,CAAC;IAC3B,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,sCAAsC;IACtC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,4BAA4B;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,4BAA4B;IAC5B,KAAK,EAAE,KAAK,CAAC;QACZ,IAAI,EAAE,cAAc,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;QACtD,YAAY,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC,CAAC;IACH,4CAA4C;IAC5C,sBAAsB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACzC,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,6BAA6B;IAC7B,OAAO,EAAE,iBAAiB,CAAC;IAC3B,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAM,CAAC,cAAc,EAAE,MAAM,CAOjE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,EAAE,MAAM,CAAC,cAAc,EAAE,MAAM,CASvE,CAAC;AAEF;;GAEG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM,CAEzD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAC1B,WAAW,EAAE,cAAc,GACzB,cAAc,GAAG,IAAI,CAMvB;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC9B,WAAW,EAAE,cAAc,GACzB,cAAc,GAAG,IAAI,CAMvB;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC9B,OAAO,EAAE,iBAAiB,EAC1B,IAAI,EAAE,cAAc,GAClB,OAAO,CAET;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,iBAAiB,GAAG,MAAM,CAMpE"}

package/dist/types/pairing.d.ts

@@ -0,0 +1,124 @@
+import type { UUID } from "./primitives";
+/**
+ * Supported pairing channels - messaging platforms that support the pairing workflow.
+ * This can be extended by plugins via module augmentation.
+ */
+export type PairingChannel = "telegram" | "discord" | "whatsapp" | "signal" | "slack" | "imessage" | "googlechat" | "msteams" | (string & {});
+/**
+ * A pending pairing request from a user trying to access the bot via DM.
+ */
+export interface PairingRequest {
+    /** Unique identifier for this request */
+    id: UUID;
+    /** The messaging channel (telegram, discord, whatsapp, etc.) */
+    channel: PairingChannel;
+    /** User identifier on the channel (userId, phoneNumber, email, etc.) */
+    senderId: string;
+    /** Human-friendly 8-character pairing code */
+    code: string;
+    /** When the request was created */
+    createdAt: Date;
+    /** When the request was last seen/updated */
+    lastSeenAt: Date;
+    /** Optional metadata about the requester */
+    metadata?: Record<string, string>;
+    /** Agent ID that received this request */
+    agentId: UUID;
+}
+/**
+ * An entry in the pairing allowlist - approved senders for a channel.
+ */
+export interface PairingAllowlistEntry {
+    /** Unique identifier for this entry */
+    id: UUID;
+    /** The messaging channel */
+    channel: PairingChannel;
+    /** Approved sender identifier */
+    senderId: string;
+    /** When the entry was added */
+    createdAt: Date;
+    /** Agent ID this allowlist belongs to */
+    agentId: UUID;
+    /** Optional metadata about the approved sender */
+    metadata?: Record<string, string>;
+}
+/**
+ * Result of upserting a pairing request
+ */
+export interface UpsertPairingRequestResult {
+    /** The pairing code (existing or newly generated) */
+    code: string;
+    /** Whether a new request was created (vs updating existing) */
+    created: boolean;
+    /** The full request object */
+    request: PairingRequest;
+}
+/**
+ * Result of approving a pairing code
+ */
+export interface ApprovePairingResult {
+    /** The sender ID that was approved */
+    senderId: string;
+    /** The original pairing request */
+    request: PairingRequest;
+    /** The new allowlist entry */
+    allowlistEntry: PairingAllowlistEntry;
+}
+/**
+ * Parameters for creating/upserting a pairing request
+ */
+export interface UpsertPairingRequestParams {
+    /** The messaging channel */
+    channel: PairingChannel;
+    /** User identifier on the channel */
+    senderId: string;
+    /** Optional metadata about the requester */
+    metadata?: Record<string, string>;
+}
+/**
+ * Parameters for approving a pairing code
+ */
+export interface ApprovePairingParams {
+    /** The messaging channel */
+    channel: PairingChannel;
+    /** The pairing code to approve */
+    code: string;
+}
+/**
+ * Channel-specific pairing adapter for customization
+ */
+export interface ChannelPairingAdapter {
+    /** Normalize an allowlist entry (e.g., phone number formatting) */
+    normalizeAllowEntry?: (entry: string) => string;
+    /** Label for the sender ID type (e.g., "userId", "phoneNumber") */
+    idLabel?: string;
+}
+/**
+ * Pairing configuration for DM access control
+ */
+export interface PairingConfig {
+    /** Maximum pending requests per channel (default: 3) */
+    maxPendingRequests?: number;
+    /** Request expiration time in milliseconds (default: 1 hour) */
+    requestTtlMs?: number;
+    /** Pairing code length (default: 8) */
+    codeLength?: number;
+}
+/**
+ * Default pairing configuration values
+ */
+export declare const DEFAULT_PAIRING_CONFIG: Required<PairingConfig>;
+/**
+ * Alphabet for generating human-friendly pairing codes.
+ * Excludes ambiguous characters (0/O, 1/I/l).
+ */
+export declare const PAIRING_CODE_ALPHABET = "ABCDEFGHJKLMNPQRSTUVWXYZ23456789";
+/**
+ * ID labels for different channels - what type of identifier is used
+ */
+export declare const PAIRING_ID_LABELS: Record<string, string>;
+/**
+ * Get the ID label for a channel
+ */
+export declare function getPairingIdLabel(channel: PairingChannel): string;
+//# sourceMappingURL=pairing.d.ts.map

package/dist/types/pairing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pairing.d.ts","sourceRoot":"","sources":["../../src/types/pairing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEzC;;;GAGG;AACH,MAAM,MAAM,cAAc,GACvB,UAAU,GACV,SAAS,GACT,UAAU,GACV,QAAQ,GACR,OAAO,GACP,UAAU,GACV,YAAY,GACZ,SAAS,GACT,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAEjB;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,yCAAyC;IACzC,EAAE,EAAE,IAAI,CAAC;IACT,gEAAgE;IAChE,OAAO,EAAE,cAAc,CAAC;IACxB,wEAAwE;IACxE,QAAQ,EAAE,MAAM,CAAC;IACjB,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,SAAS,EAAE,IAAI,CAAC;IAChB,6CAA6C;IAC7C,UAAU,EAAE,IAAI,CAAC;IACjB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,0CAA0C;IAC1C,OAAO,EAAE,IAAI,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,uCAAuC;IACvC,EAAE,EAAE,IAAI,CAAC;IACT,4BAA4B;IAC5B,OAAO,EAAE,cAAc,CAAC;IACxB,iCAAiC;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,SAAS,EAAE,IAAI,CAAC;IAChB,yCAAyC;IACzC,OAAO,EAAE,IAAI,CAAC;IACd,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,+DAA+D;IAC/D,OAAO,EAAE,OAAO,CAAC;IACjB,8BAA8B;IAC9B,OAAO,EAAE,cAAc,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,mCAAmC;IACnC,OAAO,EAAE,cAAc,CAAC;IACxB,8BAA8B;IAC9B,cAAc,EAAE,qBAAqB,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,4BAA4B;IAC5B,OAAO,EAAE,cAAc,CAAC;IACxB,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,4BAA4B;IAC5B,OAAO,EAAE,cAAc,CAAC;IACxB,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,mEAAmE;IACnE,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;IAChD,mEAAmE;IACnE,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,wDAAwD;IACxD,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gEAAgE;IAChE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uCAAuC;IACvC,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB,EAAE,QAAQ,CAAC,aAAa,CAI1D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,qCAAqC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CASpD,CAAC;AAEF;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,cAAc,GAAG,MAAM,CAEjE"}

package/dist/types/payment.d.ts

@@ -0,0 +1,45 @@
+import type { JsonObject } from "./proto.js";
+/**
+ * Payment configuration definition for x402-enabled routes.
+ */
+export interface PaymentConfigDefinition {
+    network: string;
+    assetNamespace: string;
+    assetReference: string;
+    paymentAddress: string;
+    symbol: string;
+    chainId?: string;
+}
+/**
+ * x402 configuration for a paid route.
+ */
+export interface X402Config {
+    priceInCents: number;
+    paymentConfigs?: string[];
+}
+/**
+ * x402 "accepts" entry describing payment terms.
+ */
+export interface X402Accepts {
+    scheme: "exact";
+    network: string;
+    maxAmountRequired: string;
+    resource: string;
+    description: string;
+    mimeType: string;
+    payTo: string;
+    maxTimeoutSeconds: number;
+    asset: string;
+    outputSchema?: JsonObject;
+    extra?: JsonObject;
+}
+/**
+ * x402 payment-required response payload.
+ */
+export interface X402Response {
+    x402Version: number;
+    error?: string;
+    accepts?: X402Accepts[];
+    payer?: string;
+}
+//# sourceMappingURL=payment.d.ts.map

package/dist/types/payment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment.d.ts","sourceRoot":"","sources":["../../src/types/payment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,MAAM,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,UAAU,CAAC;IAC1B,KAAK,CAAC,EAAE,UAAU,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf"}