@supertokens-plugins/opentelemetry-nodejs

Public root exports for @supertokens-plugins/opentelemetry-nodejs 0.1.2.

Package version: 0.1.2

Generated from the packed release’s root declaration, ./dist/index.d.ts. Only exports reachable from that root are listed. See the immutable release source.

Public root exports

default

Published from the emitted _default declaration.

Root export:

export { PLUGIN_ID, type OpenTelemetryLoggerPluginConfig as SuperTokensPluginOpenTelemetryLoggerConfig, _default as default, init };

Resolved declaration:

import * as _shared_js from '@shared/js';
import * as supertokens_node from 'supertokens-node';
declare const _default: {
    init: (config?: {
        override?: ((oI: _shared_js.OverridableFunctions<PluginImpl>) => _shared_js.OverridableFunctions<PluginImpl>) | undefined;
    } | undefined) => supertokens_node.SuperTokensPlugin;
};

init

Root export:

export { PLUGIN_ID, type OpenTelemetryLoggerPluginConfig as SuperTokensPluginOpenTelemetryLoggerConfig, _default as default, init };

Resolved declaration:

import * as _shared_js from '@shared/js';
import { HttpRequest, UserContext, SuperTokensPlugin } from 'supertokens-node/types';
declare const init: (config?: {
    override?: ((oI: _shared_js.OverridableFunctions<PluginImpl>) => _shared_js.OverridableFunctions<PluginImpl>) | undefined;
} | undefined) => SuperTokensPlugin;

PLUGIN_ID

Root export:

export { PLUGIN_ID, type OpenTelemetryLoggerPluginConfig as SuperTokensPluginOpenTelemetryLoggerConfig, _default as default, init };

Resolved declaration:

declare const PLUGIN_ID = "supertokens-plugin-opentelemetry";

SuperTokensPluginOpenTelemetryLoggerConfig

Published from the emitted OpenTelemetryLoggerPluginConfig declaration.

Root export:

export { PLUGIN_ID, type OpenTelemetryLoggerPluginConfig as SuperTokensPluginOpenTelemetryLoggerConfig, _default as default, init };

Resolved declaration:

type OpenTelemetryLoggerPluginConfig = {} | undefined;

Required signature types

These declarations are not additional package-root exports. They are included because the public signatures above depend on them.

PluginImpl

import { Tracer, AttributeValue, SpanStatus, Span } from '@opentelemetry/api';
import { HttpRequest, UserContext, SuperTokensPlugin } from 'supertokens-node/types';
declare class PluginImpl {
    constructor(config: OpenTelemetryLoggerPluginConfig);
    startSpan: (this: PluginImpl, tracer: Tracer, spanName: string, attributes: Record<string, any>) => {
        end: () => void;
        addEvent: (eventName: string, attributes: Record<string, AttributeValue>) => void;
        setAttributes: (attributes: Record<string, AttributeValue>) => void;
        setStatus: (status: SpanStatus) => void;
    };
    startActiveSpan: <T>(this: PluginImpl, tracer: Tracer, spanName: string, attributes: Record<string, any>, fn: (span: Span) => T) => T;
    getTracer: (this: PluginImpl) => Tracer;
    transformInputToAttributes: (this: PluginImpl, input: unknown) => Record<string, AttributeValue>;
    transformResultToAttributes: (this: PluginImpl, input: unknown) => Record<string, AttributeValue>;
    transformErrorToAttributes: (this: PluginImpl, error: unknown) => Record<string, AttributeValue>;
    getSensitiveFields: (this: PluginImpl, defaultSensitiveFields: string[]) => string[];
    getTracingHeadersForCoreCall: (this: PluginImpl, req: HttpRequest, userContext: UserContext) => Record<string, string>;
}