@berachain/berajs 0.2.8-beta.1 → 0.2.8-beta.11

package/dist/RequestError-BRIiJgHk.d.ts

@@ -0,0 +1,144 @@
+import { ErrorLike } from '@apollo/client';
+import { B as BeraError, I as IBeraErrorArgs } from './BeraError-_mQdkanr.js';
+
+interface EventsMap {
+    [event: string]: any;
+}
+interface DefaultEvents extends EventsMap {
+    [event: string]: (...args: any) => void;
+}
+type Unsubscribe = () => void;
+/**
+ * An interface for mixins that expose the `on` function (without the emitter
+ * bound to `this`)
+ *
+ * ```js
+ * import { createEmitter } from '~utils/createEmitter'
+ *
+ * class Ticker implements EmitterMixin<Events> {
+ *   constructor() {
+ *     this.emitter = createEmitter()
+ *   }
+ *   on(...args) {
+ *     return this.emitter.on(...args)
+ *   }
+ *   tick() {
+ *     this.emitter.emit('tick')
+ *   }
+ * }
+ * ```
+ */
+interface EmitterMixin<Events extends EventsMap = DefaultEvents> {
+    on<K extends keyof Events>(event: K, cb: Events[K]): Unsubscribe;
+}
+
+/**
+ * Span context passed to tracing handlers.
+ * Compatible with Sentry's StartSpanOptions (name, op, attributes).
+ */
+type SpanContext = {
+    name: string;
+    op: string;
+    attributes: Record<string, string | number | boolean | undefined>;
+};
+/**
+ * A function that wraps a callback in a tracing span.
+ * Compatible with Sentry.startSpan's signature.
+ */
+type StartSpanFn = <T>(context: SpanContext, callback: () => Promise<T>) => Promise<T>;
+/**
+ * A generic span-tracing module for berajs.
+ *
+ * Instead of calling Sentry.startSpan directly, berajs calls
+ * `BeraTracing.startSpan()`. Consumer apps subscribe via `.on("span", handler)`
+ * and forward spans to their tracing provider (Sentry, Datadog, etc.).
+ *
+ * Multiple handlers are supported and chain in registration order:
+ * the first registered handler is the outermost wrapper.
+ *
+ * @example
+ * ```ts
+ * // In berajs code:
+ * import { BeraTracing } from "./BeraTracing";
+ * const result = await BeraTracing.startSpan(
+ *   { name: "GraphQL query", op: "graphql.query", attributes: {} },
+ *   () => executeQuery(),
+ * );
+ *
+ * // In app instrumentation:
+ * import { BeraTracing } from "@berachain/berajs/errors";
+ * BeraTracing.addSpanHandler(Sentry.startSpan);
+ * ```
+ */
+declare const BeraTracing: {
+    /**
+     * Execute a callback, wrapping it in all registered span handlers.
+     *
+     * Handlers chain so each wraps the next. First registered = outermost wrapper.
+     * If no handlers are registered, the callback is executed directly.
+     */
+    startSpan<T>(context: SpanContext, callback: () => Promise<T>): Promise<T>;
+    /**
+     * Register a span tracing handler.
+     *
+     * @param _event - Must be "span". Exists for API consistency with BeraMonitoring.
+     * @param handler - A StartSpanFn, e.g. Sentry.startSpan.
+     * @returns An unsubscribe function to remove the handler.
+     */
+    addSpanHandler(handler: StartSpanFn): Unsubscribe;
+};
+
+/**
+ * This is an error class that should be used to handle errors from fetch requests.
+ */
+declare class RequestError extends BeraError {
+    /**
+     * The error response from the request.
+     */
+    response: Response | ErrorLike | undefined;
+    static isCorsError(error: Error): boolean;
+    /**
+     * The endpoint that was requested.
+     */
+    endpoint: {
+        name?: string;
+        url: string;
+        type?: "rest" | "graphql" | "rpc";
+    };
+    /**
+     * A list of domains that should have their query params removed.
+     */
+    private queryRichfulDomains;
+    statusCode: number | undefined;
+    payload?: object;
+    static readonly REASON_MAP: {
+        readonly 429: "RATE_LIMITED_429";
+        readonly NETWORK_ERROR: "NETWORK_ERROR";
+        readonly CORS_ERROR: "CORS";
+    };
+    constructor(args: IBeraErrorArgs & {
+        response: Response | ErrorLike | undefined;
+        /**
+         * The payload sent to the request.
+         */
+        payload?: object;
+        endpoint: string | URL | {
+            name?: string;
+            url: string | URL;
+            type: "rest" | "graphql" | "rpc";
+        };
+        statusCode?: number;
+    });
+    setEndpoint(endpoint: string | URL | {
+        name?: string;
+        url: string | URL;
+        type?: "rest" | "graphql" | "rpc";
+    }): {
+        name?: string;
+        url: string;
+        type?: "rest" | "graphql" | "rpc";
+    };
+    private tryMatchNetworkError;
+}
+
+export { BeraTracing as B, type EmitterMixin as E, RequestError as R, type SpanContext as S };

package/dist/RequestError-DSUzJ1Iy.d.cts

@@ -0,0 +1,144 @@
+import { ErrorLike } from '@apollo/client';
+import { B as BeraError, I as IBeraErrorArgs } from './BeraError-_mQdkanr.cjs';
+
+interface EventsMap {
+    [event: string]: any;
+}
+interface DefaultEvents extends EventsMap {
+    [event: string]: (...args: any) => void;
+}
+type Unsubscribe = () => void;
+/**
+ * An interface for mixins that expose the `on` function (without the emitter
+ * bound to `this`)
+ *
+ * ```js
+ * import { createEmitter } from '~utils/createEmitter'
+ *
+ * class Ticker implements EmitterMixin<Events> {
+ *   constructor() {
+ *     this.emitter = createEmitter()
+ *   }
+ *   on(...args) {
+ *     return this.emitter.on(...args)
+ *   }
+ *   tick() {
+ *     this.emitter.emit('tick')
+ *   }
+ * }
+ * ```
+ */
+interface EmitterMixin<Events extends EventsMap = DefaultEvents> {
+    on<K extends keyof Events>(event: K, cb: Events[K]): Unsubscribe;
+}
+
+/**
+ * Span context passed to tracing handlers.
+ * Compatible with Sentry's StartSpanOptions (name, op, attributes).
+ */
+type SpanContext = {
+    name: string;
+    op: string;
+    attributes: Record<string, string | number | boolean | undefined>;
+};
+/**
+ * A function that wraps a callback in a tracing span.
+ * Compatible with Sentry.startSpan's signature.
+ */
+type StartSpanFn = <T>(context: SpanContext, callback: () => Promise<T>) => Promise<T>;
+/**
+ * A generic span-tracing module for berajs.
+ *
+ * Instead of calling Sentry.startSpan directly, berajs calls
+ * `BeraTracing.startSpan()`. Consumer apps subscribe via `.on("span", handler)`
+ * and forward spans to their tracing provider (Sentry, Datadog, etc.).
+ *
+ * Multiple handlers are supported and chain in registration order:
+ * the first registered handler is the outermost wrapper.
+ *
+ * @example
+ * ```ts
+ * // In berajs code:
+ * import { BeraTracing } from "./BeraTracing";
+ * const result = await BeraTracing.startSpan(
+ *   { name: "GraphQL query", op: "graphql.query", attributes: {} },
+ *   () => executeQuery(),
+ * );
+ *
+ * // In app instrumentation:
+ * import { BeraTracing } from "@berachain/berajs/errors";
+ * BeraTracing.addSpanHandler(Sentry.startSpan);
+ * ```
+ */
+declare const BeraTracing: {
+    /**
+     * Execute a callback, wrapping it in all registered span handlers.
+     *
+     * Handlers chain so each wraps the next. First registered = outermost wrapper.
+     * If no handlers are registered, the callback is executed directly.
+     */
+    startSpan<T>(context: SpanContext, callback: () => Promise<T>): Promise<T>;
+    /**
+     * Register a span tracing handler.
+     *
+     * @param _event - Must be "span". Exists for API consistency with BeraMonitoring.
+     * @param handler - A StartSpanFn, e.g. Sentry.startSpan.
+     * @returns An unsubscribe function to remove the handler.
+     */
+    addSpanHandler(handler: StartSpanFn): Unsubscribe;
+};
+
+/**
+ * This is an error class that should be used to handle errors from fetch requests.
+ */
+declare class RequestError extends BeraError {
+    /**
+     * The error response from the request.
+     */
+    response: Response | ErrorLike | undefined;
+    static isCorsError(error: Error): boolean;
+    /**
+     * The endpoint that was requested.
+     */
+    endpoint: {
+        name?: string;
+        url: string;
+        type?: "rest" | "graphql" | "rpc";
+    };
+    /**
+     * A list of domains that should have their query params removed.
+     */
+    private queryRichfulDomains;
+    statusCode: number | undefined;
+    payload?: object;
+    static readonly REASON_MAP: {
+        readonly 429: "RATE_LIMITED_429";
+        readonly NETWORK_ERROR: "NETWORK_ERROR";
+        readonly CORS_ERROR: "CORS";
+    };
+    constructor(args: IBeraErrorArgs & {
+        response: Response | ErrorLike | undefined;
+        /**
+         * The payload sent to the request.
+         */
+        payload?: object;
+        endpoint: string | URL | {
+            name?: string;
+            url: string | URL;
+            type: "rest" | "graphql" | "rpc";
+        };
+        statusCode?: number;
+    });
+    setEndpoint(endpoint: string | URL | {
+        name?: string;
+        url: string | URL;
+        type?: "rest" | "graphql" | "rpc";
+    }): {
+        name?: string;
+        url: string;
+        type?: "rest" | "graphql" | "rpc";
+    };
+    private tryMatchNetworkError;
+}
+
+export { BeraTracing as B, type EmitterMixin as E, RequestError as R, type SpanContext as S };