@tracewayapp/opamp 0.0.0-stage → 2.0.0-beta.1

package/dist/index.d.mts

@@ -0,0 +1,150 @@
+/** AgentCapabilities from the OpAMP spec. */
+declare const AgentCapabilities: {
+    readonly ReportsStatus: 1;
+    readonly AcceptsRemoteConfig: 2;
+    readonly ReportsEffectiveConfig: 4;
+    readonly ReportsHealth: 2048;
+    readonly ReportsRemoteConfig: 4096;
+    readonly ReportsHeartbeat: 8192;
+};
+declare const AgentToServerFlags: {
+    readonly RequestInstanceUid: 1;
+};
+declare const ServerToAgentFlags: {
+    readonly ReportFullState: 1;
+};
+declare enum RemoteConfigStatus {
+    Unset = 0,
+    Applied = 1,
+    Applying = 2,
+    Failed = 3
+}
+declare enum ServerErrorType {
+    Unknown = 0,
+    BadRequest = 1,
+    Unavailable = 2
+}
+type AttributeValue = string | boolean | number | string[];
+interface AgentToServer {
+    instanceUid: Uint8Array;
+    sequenceNum: number;
+    agentDescription?: {
+        identifying: Record<string, AttributeValue>;
+        nonIdentifying: Record<string, AttributeValue>;
+    };
+    capabilities: number;
+    remoteConfigStatus?: {
+        lastRemoteConfigHash: Uint8Array;
+        status: RemoteConfigStatus;
+        errorMessage?: string;
+    };
+    agentDisconnect?: boolean;
+    flags?: number;
+    customCapabilities?: string[];
+}
+interface AgentConfigObject {
+    body: Uint8Array;
+    contentType: string;
+}
+interface ServerToAgent {
+    instanceUid?: Uint8Array;
+    errorResponse?: {
+        type: ServerErrorType;
+        message: string;
+        retryAfterMs?: number;
+    };
+    remoteConfig?: {
+        configMap: Record<string, AgentConfigObject>;
+        configHash: Uint8Array;
+    };
+    heartbeatIntervalSeconds?: number;
+    flags: number;
+    capabilities: number;
+    newInstanceUid?: Uint8Array;
+    customMessage?: {
+        capability: string;
+        type: string;
+        data: Uint8Array;
+    };
+}
+declare function encodeAgentToServer(msg: AgentToServer): Uint8Array;
+declare function decodeServerToAgent(buf: Uint8Array): ServerToAgent;
+/** Encodes the parts of a ServerToAgent this client reads; for mock servers in tests. */
+declare function encodeServerToAgent(msg: Omit<ServerToAgent, "errorResponse" | "customMessage">): Uint8Array;
+
+interface AgentDescription {
+    identifying: Record<string, AttributeValue>;
+    nonIdentifying: Record<string, AttributeValue>;
+}
+interface RemoteConfig {
+    configMap: Record<string, AgentConfigObject>;
+    configHash: Uint8Array;
+}
+type ApplyResult = {
+    applied: true;
+} | {
+    applied: false;
+    errorMessage: string;
+};
+interface OpampClientOptions {
+    /** The server's OpAMP endpoint, e.g. https://traceway.example.com/api/otel/v1/opamp. */
+    endpoint: string;
+    headers?: Record<string, string>;
+    instanceUid: Uint8Array;
+    capabilities: number;
+    customCapabilities?: string[];
+    /** Read on every poll: the client sends its full state each time, so a stateless server can answer. */
+    describe: () => AgentDescription;
+    onRemoteConfig: (config: RemoteConfig) => ApplyResult;
+    /** Hash of the config applied on an earlier page, so the server does not resend what is already in effect. */
+    appliedConfigHash?: Uint8Array;
+    onHeartbeatChange?: (seconds: number) => void;
+    onInstanceUidChange?: (uid: Uint8Array) => void;
+    /** Called once when the server rejects the credentials; the client stops polling. */
+    onUnauthorized?: () => void;
+    /** A pre-OpAMP server: stop polling and let the SDK use its legacy protocol. */
+    onUnsupported?: () => void;
+    /** Fetch failed, including a missing CORS preflight on older cross-origin servers. */
+    onUnavailable?: () => void;
+    onConnected?: () => void;
+    defaultPollIntervalMs?: number;
+    fetchImpl?: typeof fetch;
+    requestTimeoutMs?: number;
+}
+declare function uuidString(bytes: Uint8Array): string;
+/**
+ * An OpAMP client for the plain-HTTP transport: it polls, applies the remote
+ * config the server offers and reports the result on the next poll. Polling
+ * follows the server's heartbeat interval, backs off on errors and honours
+ * Retry-After; a 413 is not retried and a 401/403 stops the client.
+ */
+declare class OpampHttpClient {
+    private readonly options;
+    private uid;
+    private sequenceNum;
+    private status;
+    private intervalMs;
+    private backoffMs;
+    private timer;
+    private inFlight;
+    private stopped;
+    private lastPollAt;
+    private readonly fetchImpl;
+    constructor(options: OpampClientOptions);
+    start(): void;
+    stop(): void;
+    pollIntervalMs(): number;
+    millisSinceLastPoll(): number;
+    /** Polls now unless a poll is running or the client is backing off after an error. */
+    poll(): Promise<void>;
+    /** Polls with the current description even if a poll is under way, e.g. right after a targeting attribute changed. */
+    refresh(): Promise<void>;
+    private schedule;
+    private exchange;
+    private exchangeWithSignal;
+    private handle;
+    private backOff;
+    private send;
+}
+
+export { AgentCapabilities, type AgentConfigObject, type AgentDescription, type AgentToServer, AgentToServerFlags, type ApplyResult, type AttributeValue, type OpampClientOptions, OpampHttpClient, type RemoteConfig, RemoteConfigStatus, ServerErrorType, type ServerToAgent, ServerToAgentFlags, decodeServerToAgent, encodeAgentToServer, encodeServerToAgent, uuidString };

package/dist/index.d.ts

@@ -0,0 +1,150 @@
+/** AgentCapabilities from the OpAMP spec. */
+declare const AgentCapabilities: {
+    readonly ReportsStatus: 1;
+    readonly AcceptsRemoteConfig: 2;
+    readonly ReportsEffectiveConfig: 4;
+    readonly ReportsHealth: 2048;
+    readonly ReportsRemoteConfig: 4096;
+    readonly ReportsHeartbeat: 8192;
+};
+declare const AgentToServerFlags: {
+    readonly RequestInstanceUid: 1;
+};
+declare const ServerToAgentFlags: {
+    readonly ReportFullState: 1;
+};
+declare enum RemoteConfigStatus {
+    Unset = 0,
+    Applied = 1,
+    Applying = 2,
+    Failed = 3
+}
+declare enum ServerErrorType {
+    Unknown = 0,
+    BadRequest = 1,
+    Unavailable = 2
+}
+type AttributeValue = string | boolean | number | string[];
+interface AgentToServer {
+    instanceUid: Uint8Array;
+    sequenceNum: number;
+    agentDescription?: {
+        identifying: Record<string, AttributeValue>;
+        nonIdentifying: Record<string, AttributeValue>;
+    };
+    capabilities: number;
+    remoteConfigStatus?: {
+        lastRemoteConfigHash: Uint8Array;
+        status: RemoteConfigStatus;
+        errorMessage?: string;
+    };
+    agentDisconnect?: boolean;
+    flags?: number;
+    customCapabilities?: string[];
+}
+interface AgentConfigObject {
+    body: Uint8Array;
+    contentType: string;
+}
+interface ServerToAgent {
+    instanceUid?: Uint8Array;
+    errorResponse?: {
+        type: ServerErrorType;
+        message: string;
+        retryAfterMs?: number;
+    };
+    remoteConfig?: {
+        configMap: Record<string, AgentConfigObject>;
+        configHash: Uint8Array;
+    };
+    heartbeatIntervalSeconds?: number;
+    flags: number;
+    capabilities: number;
+    newInstanceUid?: Uint8Array;
+    customMessage?: {
+        capability: string;
+        type: string;
+        data: Uint8Array;
+    };
+}
+declare function encodeAgentToServer(msg: AgentToServer): Uint8Array;
+declare function decodeServerToAgent(buf: Uint8Array): ServerToAgent;
+/** Encodes the parts of a ServerToAgent this client reads; for mock servers in tests. */
+declare function encodeServerToAgent(msg: Omit<ServerToAgent, "errorResponse" | "customMessage">): Uint8Array;
+
+interface AgentDescription {
+    identifying: Record<string, AttributeValue>;
+    nonIdentifying: Record<string, AttributeValue>;
+}
+interface RemoteConfig {
+    configMap: Record<string, AgentConfigObject>;
+    configHash: Uint8Array;
+}
+type ApplyResult = {
+    applied: true;
+} | {
+    applied: false;
+    errorMessage: string;
+};
+interface OpampClientOptions {
+    /** The server's OpAMP endpoint, e.g. https://traceway.example.com/api/otel/v1/opamp. */
+    endpoint: string;
+    headers?: Record<string, string>;
+    instanceUid: Uint8Array;
+    capabilities: number;
+    customCapabilities?: string[];
+    /** Read on every poll: the client sends its full state each time, so a stateless server can answer. */
+    describe: () => AgentDescription;
+    onRemoteConfig: (config: RemoteConfig) => ApplyResult;
+    /** Hash of the config applied on an earlier page, so the server does not resend what is already in effect. */
+    appliedConfigHash?: Uint8Array;
+    onHeartbeatChange?: (seconds: number) => void;
+    onInstanceUidChange?: (uid: Uint8Array) => void;
+    /** Called once when the server rejects the credentials; the client stops polling. */
+    onUnauthorized?: () => void;
+    /** A pre-OpAMP server: stop polling and let the SDK use its legacy protocol. */
+    onUnsupported?: () => void;
+    /** Fetch failed, including a missing CORS preflight on older cross-origin servers. */
+    onUnavailable?: () => void;
+    onConnected?: () => void;
+    defaultPollIntervalMs?: number;
+    fetchImpl?: typeof fetch;
+    requestTimeoutMs?: number;
+}
+declare function uuidString(bytes: Uint8Array): string;
+/**
+ * An OpAMP client for the plain-HTTP transport: it polls, applies the remote
+ * config the server offers and reports the result on the next poll. Polling
+ * follows the server's heartbeat interval, backs off on errors and honours
+ * Retry-After; a 413 is not retried and a 401/403 stops the client.
+ */
+declare class OpampHttpClient {
+    private readonly options;
+    private uid;
+    private sequenceNum;
+    private status;
+    private intervalMs;
+    private backoffMs;
+    private timer;
+    private inFlight;
+    private stopped;
+    private lastPollAt;
+    private readonly fetchImpl;
+    constructor(options: OpampClientOptions);
+    start(): void;
+    stop(): void;
+    pollIntervalMs(): number;
+    millisSinceLastPoll(): number;
+    /** Polls now unless a poll is running or the client is backing off after an error. */
+    poll(): Promise<void>;
+    /** Polls with the current description even if a poll is under way, e.g. right after a targeting attribute changed. */
+    refresh(): Promise<void>;
+    private schedule;
+    private exchange;
+    private exchangeWithSignal;
+    private handle;
+    private backOff;
+    private send;
+}
+
+export { AgentCapabilities, type AgentConfigObject, type AgentDescription, type AgentToServer, AgentToServerFlags, type ApplyResult, type AttributeValue, type OpampClientOptions, OpampHttpClient, type RemoteConfig, RemoteConfigStatus, ServerErrorType, type ServerToAgent, ServerToAgentFlags, decodeServerToAgent, encodeAgentToServer, encodeServerToAgent, uuidString };