generalcontext 0.0.0-stage → 0.3.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,5 @@
+General Context SDK
+Copyright 2026 General Context Labs, Inc.
+
+This product includes software developed at General Context Labs, Inc.
+(https://generalcontextlabs.com).

package/README.md

@@ -1,3 +1,65 @@
-# Temporary Holding Version
+# generalcontext
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Record your AI agent's model calls for [General Context](https://generalcontextlabs.com/docs). We read your agent's production conversations and find where it goes wrong, and each failure you confirm becomes an RL and eval task built from the conversation. Your tasks together are your benchmark.
+
+Recording never gets in your agent's way: calls are sent in the background, a failure on our side is logged and dropped, never thrown, and there are no runtime dependencies.
+
+## Install
+
+```sh
+npm install generalcontext
+```
+
+Set `GENERALCONTEXT_API_KEY` to the key from your workspace's Connect page.
+
+## Record
+
+Call `initialize()` once per process, before your agent makes model calls. Pass the client modules you use: it is required whenever a bundler is involved.
+
+```ts
+import OpenAI from 'openai';
+import Anthropic from '@anthropic-ai/sdk';
+import { initialize, withSession, flush } from 'generalcontext';
+
+initialize({ appName: 'support-agent', instrumentModules: { openAI: OpenAI, anthropic: Anthropic } });
+
+// Group every call in one conversation under the id you already use for it
+await withSession({ sessionId: conversationId, userId: customerId, channel: 'chat' }, () => handle(message));
+
+await flush(); // before a serverless function, job or script exits
+```
+
+If your app serves several companies of its own, pass `account` to `withSession` (the id or name you already use for that company) so conversations are grouped by account.
+
+| Provider | Package | `instrumentModules` key |
+| - | - | - |
+| OpenAI, including Azure OpenAI | `openai` | `openAI` |
+| Anthropic, including Bedrock, Vertex and beta | `@anthropic-ai/sdk` | `anthropic` |
+| Google Gemini | `@google/genai` | `googleGenAI` |
+| AWS Bedrock Converse | `@aws-sdk/client-bedrock-runtime` | `bedrockRuntime` |
+| Anything else | Send [OpenTelemetry](https://generalcontextlabs.com/docs/opentelemetry) | |
+
+**Voice (OpenAI Realtime).** `OpenAIRealtimeWS` (`openai/realtime/ws`) and `OpenAIRealtimeWebSocket`
+(`openai/realtime/websocket`) connections are recorded too. Create the connection inside `withSession(...)` and
+the whole call lands in that conversation. Each `response.done` is recorded as one `openai-realtime` call shaped
+like a Responses call: the instructions and tools, the conversation so far as text (caller turns from the input
+transcription, agent turns from the output transcript, tool calls and their results), and a `voice` field with
+`speech_stopped_at`, `first_audio_at`, `interrupted` and `truncated_at_ms`. Turn on input audio transcription in
+the session to record what the caller said. Audio is never recorded. Pass a connection to `wrap()` to record only
+that one.
+
+Node 18 to 24, Node.js runtime only (not Edge). Supported client versions, Next.js, proxies, redaction, outcomes and events, and every option: [SDK reference](https://generalcontextlabs.com/docs/sdk).
+
+## Command line
+
+```sh
+npx generalcontext verify                      # the key works, and when the last call arrived
+npx generalcontext verify --session conv-123   # that one conversation arrived
+npx generalcontext benchmark pull --out benchmark.json
+```
+
+Running the benchmark is in the Python package. See the [command line docs](https://generalcontextlabs.com/docs/cli).
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,175 @@
+#!/usr/bin/env node
+// Copyright 2026 General Context Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+// generalcontext verify [--session ID] [--json]
+// generalcontext benchmark pull [--out FILE]
+// Exit 0 on success, 1 on a failed check, 2 on a usage or configuration error. No runtime dependencies.
+import { writeFileSync } from 'node:fs';
+const DEFAULT_BASE_URL = 'https://generalcontextlabs.com';
+const TIMEOUT_MS = 30_000;
+const USAGE = `Usage:
+  generalcontext verify [--session ID] [--json]
+  generalcontext benchmark pull [--out FILE]
+Uses GENERALCONTEXT_API_KEY and GENERALCONTEXT_BASE_URL.`;
+const PYTHON_HINT = 'Run the benchmark with Python: pip install generalcontext && generalcontext evals run ...';
+class Exit extends Error {
+    code;
+    constructor(code, message) {
+        super(message);
+        this.code = code;
+    }
+}
+const trimSlashes = (url) => { let end = url.length; while (end > 0 && url[end - 1] === '/')
+    end--; return url.slice(0, end); };
+// Same rule as the SDK: https, or plain http to this machine only.
+function secureUrl(url) {
+    try {
+        const u = new URL(url);
+        return u.protocol === 'https:' || (u.protocol === 'http:' && ['localhost', '127.0.0.1', '[::1]'].includes(u.hostname));
+    }
+    catch {
+        return false;
+    }
+}
+function settings() {
+    const key = (process.env.GENERALCONTEXT_API_KEY ?? '').trim();
+    if (!key)
+        throw new Exit(2, 'GENERALCONTEXT_API_KEY is not set. Create a key on the API keys page and export it.');
+    const base = trimSlashes((process.env.GENERALCONTEXT_BASE_URL ?? '').trim() || DEFAULT_BASE_URL);
+    if (!secureUrl(base))
+        throw new Exit(2, `GENERALCONTEXT_BASE_URL ${base} is not https. Use https, or http://localhost for local development.`);
+    return { key, base };
+}
+async function get(path) {
+    const { key, base } = settings();
+    let response;
+    try {
+        response = await fetch(`${base}/api/platform-collect${path}`, {
+            headers: { Authorization: `Bearer ${key}`, Accept: 'application/json' },
+            redirect: 'error', // never forward the key to another host
+            signal: AbortSignal.timeout(TIMEOUT_MS),
+        });
+    }
+    catch (error) {
+        throw new Exit(1, `Could not reach ${base}: ${error.message}`);
+    }
+    const text = await response.text();
+    let body = null;
+    try {
+        body = text ? JSON.parse(text) : null;
+    }
+    catch { /* not JSON */ }
+    return { status: response.status, body };
+}
+const errorText = (status, body) => typeof body?.error === 'string' ? body.error : `HTTP ${status}`;
+function failed(status, body) {
+    if (status === 401)
+        throw new Exit(1, 'The API key was not accepted. Check GENERALCONTEXT_API_KEY.');
+    throw new Exit(1, `Request failed: ${errorText(status, body)}`);
+}
+function parseFlags(args, known) {
+    const out = {};
+    for (let i = 0; i < args.length; i++) {
+        let arg = args[i], value;
+        const eq = arg.indexOf('=');
+        if (arg.startsWith('--') && eq > 0) {
+            value = arg.slice(eq + 1);
+            arg = arg.slice(0, eq);
+        }
+        const kind = known[arg];
+        if (!kind)
+            throw new Exit(2, `Unknown argument ${arg}.\n${USAGE}`);
+        if (kind === 'bool') {
+            out[arg] = true;
+            continue;
+        }
+        value ??= args[++i];
+        if (value === undefined || value === '')
+            throw new Exit(2, `${arg} needs a value.\n${USAGE}`);
+        out[arg] = value;
+    }
+    return out;
+}
+const scopeWords = { ingest: 'sends traffic', evals: 'runs the benchmark' };
+async function verify(args) {
+    const flags = parseFlags(args, { '--session': 'value', '--json': 'bool' });
+    const session = flags['--session'];
+    const { status, body } = await get(`/status${session ? `?session=${encodeURIComponent(session)}` : ''}`);
+    if (status !== 200 || !body)
+        failed(status, body);
+    const found = session ? Boolean(body.session?.found) : true;
+    if (flags['--json']) {
+        console.log(JSON.stringify(body, null, 2));
+        return found ? 0 : 1;
+    }
+    const scopes = Array.isArray(body.key?.scopes) ? body.key.scopes : [];
+    const label = body.key?.label ? ` "${body.key.label}"` : '';
+    console.log(`Workspace ${body.workspace}. Key${label} ${scopes.length ? scopes.map(s => scopeWords[s] ?? s).join(' and ') : 'has no scopes'}.`);
+    console.log(body.last_call_at ? `Last call arrived ${body.last_call_at} from ${body.last_source ?? 'unknown'}.` : 'No calls have arrived yet.');
+    if (session) {
+        const s = body.session ?? {};
+        if (!found) {
+            console.log(`Conversation ${session}: not found yet.`);
+            return 1;
+        }
+        const models = Array.isArray(s.models) ? s.models : [];
+        console.log(`Conversation ${session}: arrived, ${s.calls ?? 0} call${s.calls === 1 ? '' : 's'}${models.length ? ` (${models.join(', ')})` : ''}.`);
+    }
+    return 0;
+}
+async function benchmark(args) {
+    const [sub, ...rest] = args;
+    if (sub !== 'pull')
+        throw new Exit(2, USAGE);
+    const flags = parseFlags(rest, { '--out': 'value' });
+    const out = flags['--out'] ?? 'benchmark.json';
+    const { status, body } = await get('/benchmark');
+    if (status === 403)
+        throw new Exit(1, errorText(status, body) === `HTTP 403`
+            ? 'This key cannot download the benchmark. On API keys, create a key that can run the benchmark.' : errorText(status, body));
+    if (status !== 200 || !body)
+        failed(status, body);
+    try {
+        writeFileSync(out, JSON.stringify(body, null, 2) + '\n');
+    }
+    catch (error) {
+        throw new Exit(1, `Could not write ${out}: ${error.message}`);
+    }
+    const tasks = Array.isArray(body.tasks) ? body.tasks : [];
+    const splits = new Map();
+    for (const t of tasks) {
+        const s = typeof t?.split === 'string' && t.split ? t.split : 'unsplit';
+        splits.set(s, (splits.get(s) ?? 0) + 1);
+    }
+    const bySplit = [...splits].sort(([a], [b]) => (a < b ? -1 : a > b ? 1 : 0)).map(([s, n]) => `${n} ${s}`).join(', ');
+    console.log(`Wrote ${out}: ${tasks.length} task${tasks.length === 1 ? '' : 's'}${bySplit ? ` (${bySplit})` : ''}.`);
+    return 0;
+}
+async function main(argv) {
+    const [command, ...args] = argv;
+    try {
+        if (command === 'verify')
+            return await verify(args);
+        if (command === 'benchmark')
+            return await benchmark(args);
+        if (command === 'evals') {
+            console.error(PYTHON_HINT);
+            return 2;
+        }
+        if (command === '-h' || command === '--help' || command === 'help') {
+            console.log(USAGE);
+            return 0;
+        }
+        console.error(USAGE);
+        return 2;
+    }
+    catch (error) {
+        if (error instanceof Exit) {
+            (error.code === 0 ? console.log : console.error)(error.message);
+            return error.code;
+        }
+        console.error(`generalcontext: ${error?.message ?? error}`);
+        return 1;
+    }
+}
+main(process.argv.slice(2)).then(code => { process.exitCode = code; });

package/dist/index.d.ts

@@ -0,0 +1,125 @@
+export declare const VERSION = "0.3.0";
+type Metadata = Record<string, string | number | boolean>;
+export type Session = {
+    sessionId: string;
+    userId?: string;
+    channel?: string;
+    product?: string;
+    account?: string;
+    metadata?: Metadata;
+};
+type Tags = {
+    id: string;
+    user_id?: string;
+    channel?: string;
+    product?: string;
+    account?: string;
+    metadata?: Metadata;
+};
+type Api = 'openai-chat' | 'openai-responses' | 'anthropic' | 'gemini' | 'bedrock-converse' | 'openai-realtime';
+/** Voice timing on 'openai-realtime' calls. Timestamps are ISO strings, null when not seen. */
+export type VoiceTiming = {
+    speech_stopped_at: string | null;
+    first_audio_at: string | null;
+    interrupted: boolean;
+    truncated_at_ms?: number;
+};
+export type Call = {
+    api: Api;
+    conversation: Tags | null;
+    task: string | null;
+    request: unknown;
+    response: unknown;
+    started_at: string;
+    ended_at: string;
+    error: string | null;
+    voice?: VoiceTiming;
+};
+type Scrub = (text: string) => string;
+type BeforeSend = (call: Call) => Call | null | undefined;
+export type InitializeOptions = {
+    apiKey?: string;
+    /** Collector URL. Must be https://, except http://localhost, 127.0.0.1 or [::1]. */
+    baseUrl?: string;
+    appName?: string;
+    /** true for built-in email/phone/card/SSN placeholders, or your own (text) => text. */
+    redact?: boolean | Scrub;
+    /** Runs at send time on each call, before redaction. Return the call to send, or null to drop it. */
+    beforeSend?: BeforeSend;
+    /**
+     * SDK classes or modules to patch, e.g. { openAI: OpenAI, anthropic: Anthropic }. Also accepts
+     * googleGenAI (the '@google/genai' module) and bedrockRuntime (the '@aws-sdk/client-bedrock-runtime' module).
+     */
+    instrumentModules?: Modules;
+    /** Also record raw fetch POSTs to any URL ending /chat/completions. Default false. */
+    instrumentFetch?: boolean;
+    /** Send each call right away instead of batching. */
+    disableBatch?: boolean;
+};
+type Modules = {
+    openAI?: unknown;
+    anthropic?: unknown;
+    googleGenAI?: unknown;
+    bedrockRuntime?: unknown;
+};
+/** Configure recording once per process, before your agent makes model calls. */
+export declare function initialize(options?: InitializeOptions): void;
+/**
+ * Resolves once initialize() has patched every SDK build it found, including the ES module builds it loads
+ * asynchronously. Await it when a model call may run before the app's next await after initialize(). Never rejects.
+ */
+export declare function ready(): Promise<void>;
+/** Tag every call made inside `run` with one session. `conversation` is the same function. */
+export declare function withSession<T>(session: Session | string, run: () => T): T;
+/** Older name for withSession. Accepts { id } as well as { sessionId }. */
+export declare function conversation<T>(tags: Session | {
+    id: string;
+    channel?: string;
+    product?: string;
+    account?: string;
+    metadata?: Metadata;
+} | string, run: () => T): T;
+/** Tag every call made inside `run` with a task name, such as one step of your agent loop. */
+export declare function task<T>(name: string, run: () => T): T;
+/**
+ * The copy of a call that is recorded. Never changes `value`, and never touches what the caller sends to the provider.
+ * Agents resend the whole run on every call, so without this, later calls pass the per-call limit and are lost.
+ *
+ * - Inline binary becomes a placeholder that keeps the shape: a base64 data URL keeps its prefix
+ *   (`data:image/png;base64,[omitted N bytes sha256:ab12cd34ef56]`), and a base64 `data`, `result` or
+ *   `b64_json` field (Anthropic `source.data`, Gemini `inlineData.data`, OpenAI `input_audio.data`, Responses
+ *   `image_generation_call.result`) becomes `[omitted N bytes sha256:...]`. N is the length of the base64 text
+ *   and the hash is the first 12 hex digits of the sha256 of that text, so the same image gets the same placeholder
+ *   in every call. Media types stay. Binary is never recorded: it does not help review and it is a privacy risk.
+ * - Any string over 200,000 characters keeps its first 100,000 and last 20,000 characters around
+ *   `\n[... clipped N characters ...]\n`.
+ *
+ * Runs before beforeSend and redaction. A call still over the limit afterwards is dropped.
+ */
+export declare function compactForRecording(value: unknown, key?: string, depth?: number): unknown;
+export declare function maskSecrets(text: string): string;
+/**
+ * Wait until recorded calls are sent, for at most `timeoutMs` (default 10 s). Call before a serverless
+ * function or script exits. Resolves true when the queue was sent, false at the deadline. Never throws.
+ * Sending continues in the background after the deadline.
+ */
+export declare function flush(timeoutMs?: number): Promise<boolean>;
+/** Mark how a session ended. Returns true when the platform accepted it. Never throws. */
+export declare function reportOutcome(sessionId: string, outcome: 'success' | 'fail', note?: string): Promise<boolean>;
+export type AppEvent = {
+    sessionId: string;
+    eventType: string;
+    properties?: Metadata;
+    eventId?: string;
+    timestamp?: string | Date;
+};
+/** Record something that happened in your systems, such as 'order.refunded'. Pass a stable eventId so retries dedupe. Never throws. */
+export declare function logEvent(event: AppEvent): Promise<boolean>;
+/**
+ * Record one client instance only, without initialize(). Returns the same client.
+ * `redact` applies to this client only. If initialize() already patched the SDK, its settings apply instead.
+ */
+export declare function wrap<C extends object>(client: C, options?: {
+    redact?: boolean | Scrub;
+}): C;
+export {};