notefeed 0.2.0 → 0.5.0

package/dist/client.js

@@ -1,83 +1,157 @@
-/** A tiny client for notefeed's POST /api/notes. No dependencies; uses the global fetch. */
-/** Any failure talking to notefeed. `status` is the HTTP status, or null (network, config). */
+/**
+ * The notefeed client: a small convenience layer over the API client generated from the server's
+ * OpenAPI description (./generated, `npm run generate` in the repo). No runtime dependencies.
+ */
+import { createClient, createConfig } from "./generated/client/index.js";
+import { getNote, getReadNote, listNotes, listReadNotes, postNote } from "./generated/sdk.gen.js";
+/** Any failure talking to notefeed. `status` and `code` are null when there was no API answer. */
 export class NotefeedError extends Error {
     status;
-    constructor(message, status = null) {
+    code;
+    constructor(message, status = null, code = null) {
         super(message);
         this.status = status;
+        this.code = code;
         this.name = new.target.name;
     }
 }
-/** URL or token missing. */
+/** Raised before sending: no URL, no feed, an invalid feed name or password. */
 export class ConfigError extends NotefeedError {
 }
-/** The server rejected the note (400, 415): empty, not UTF-8, wrong type. */
-export class InvalidNoteError extends NotefeedError {
-}
-/** Missing or wrong token (401). */
+/** Missing or wrong password on a locked instance. */
 export class AuthError extends NotefeedError {
 }
-/** The note is over the server's size limit (413). */
+/** Too many posts or wrong passwords. `retryAfter` is the wait in seconds, or null if none was given. */
+export class RateLimitedError extends NotefeedError {
+    retryAfter;
+    constructor(message, status, code, retryAfter) {
+        super(message, status, code);
+        this.retryAfter = retryAfter;
+    }
+}
+/** No such note, or a malformed read id. */
+export class NotFoundError extends NotefeedError {
+}
+/** The instance's feed or note limit is reached. */
+export class LimitReachedError extends NotefeedError {
+}
+/** The note is over the server's size limit. */
 export class NoteTooLargeError extends NotefeedError {
 }
-const ERRORS = {
-    400: InvalidNoteError,
-    415: InvalidNoteError,
-    401: AuthError,
-    413: NoteTooLargeError,
+/** The server refused the request itself: invalid or reserved feed, empty note, bad body or parameter. */
+export class InvalidRequestError extends NotefeedError {
+}
+const BY_CODE = {
+    auth: AuthError,
+    not_found: NotFoundError,
+    feed_limit: LimitReachedError,
+    note_limit: LimitReachedError,
+    too_large: NoteTooLargeError,
+    invalid_feed: InvalidRequestError,
+    reserved_feed: InvalidRequestError,
+    empty_note: InvalidRequestError,
+    invalid_body: InvalidRequestError,
+    invalid_request: InvalidRequestError,
+    unsupported_type: InvalidRequestError,
 };
+const FEED_RE = /^[a-z0-9_-]{1,64}$/; // same rule as the server; reserved names still come back as a 400
 export class Client {
     url;
-    token;
+    feed;
+    api;
     timeoutMs;
-    /** A notefeed server. URL and token are set once here; post() takes only the note. */
+    /** A notefeed server. The feed set here is the default for every call; each call can override it. */
     constructor(options) {
-        const { url, token, timeoutMs } = options ?? {};
+        const { url, feed, password, timeoutMs } = options ?? {};
         if (!url)
             throw new ConfigError("no url given");
-        if (!token?.trim())
-            throw new ConfigError("no token given");
         this.url = url.replace(/\/+$/, "");
-        this.token = token.trim();
+        this.feed = feed ? checkFeed(feed) : null;
+        const pw = password?.trim() || null;
         // Never echo the value: it would end up in terminals and CI logs.
-        if (/[\x00-\x1f\x7f]/.test(this.token))
-            throw new ConfigError("token contains invalid characters");
+        if (pw && /[\x00-\x1f\x7f]/.test(pw))
+            throw new ConfigError("password contains invalid characters");
         this.timeoutMs = timeoutMs ?? 10_000;
+        this.api = createClient(createConfig({ baseUrl: this.url, headers: pw ? { Authorization: `Bearer ${pw}` } : {} }));
     }
-    async post(markdown) {
-        let res;
-        try {
-            res = await fetch(`${this.url}/api/notes`, {
-                method: "POST",
-                headers: { Authorization: `Bearer ${this.token}`, "Content-Type": "text/markdown; charset=utf-8" },
-                body: new TextEncoder().encode(markdown),
-                signal: AbortSignal.timeout(this.timeoutMs),
-            });
-        }
-        catch (e) {
-            const cause = e.cause;
-            const reason = cause?.code ?? cause?.message ?? e.message;
+    /** NOTEFEED_URL, NOTEFEED_FEED and NOTEFEED_PASSWORD. */
+    static fromEnv(env = process.env) {
+        return new Client({ url: env.NOTEFEED_URL ?? "", feed: env.NOTEFEED_FEED || undefined, password: env.NOTEFEED_PASSWORD });
+    }
+    async post(markdown, options = {}) {
+        const feed = this.feedFor(options.feed);
+        return this.call(postNote({ client: this.api, path: { feed }, body: { markdown }, ...this.opts() }));
+    }
+    /** Every note in the feed, newest first, fetched a page at a time; stop iterating whenever you like. */
+    notes(options = {}) {
+        const feed = this.feedFor(options.feed);
+        return this.pages((before) => listNotes({ client: this.api, path: { feed }, query: { limit: options.pageSize, before }, ...this.opts() }));
+    }
+    async note(id, options = {}) {
+        const feed = this.feedFor(options.feed);
+        return this.call(getNote({ client: this.api, path: { feed, id }, ...this.opts() }));
+    }
+    /** Like notes(), by the feed's read id: public, read-only, needs no password. */
+    readNotes(readId, options = {}) {
+        return this.pages((before) => listReadNotes({ client: this.api, path: { readId }, query: { limit: options.pageSize, before }, ...this.opts() }));
+    }
+    async readNote(readId, id) {
+        return this.call(getReadNote({ client: this.api, path: { readId, id }, ...this.opts() }));
+    }
+    feedFor(feed) {
+        const f = feed || this.feed;
+        if (!f)
+            throw new ConfigError("no feed given");
+        return checkFeed(f);
+    }
+    opts() {
+        return { signal: AbortSignal.timeout(this.timeoutMs) };
+    }
+    // `before` is the previous page's `next`: older notes only, so notes posted meanwhile never repeat.
+    async *pages(fetchPage) {
+        let before;
+        do {
+            const page = await this.call(fetchPage(before));
+            yield* page.notes;
+            before = page.next ?? undefined;
+        } while (before);
+    }
+    // Anything but a JSON object from the API itself is an error, never a success: a POST that was
+    // redirected (http → https) came back as a GET of the list, so the note was never stored.
+    async call(request) {
+        const { data, error, response } = await request;
+        if (!response) {
+            const cause = error?.cause;
+            const reason = cause?.code ?? cause?.message ?? error?.message ?? "unknown error";
             throw new NotefeedError(`could not reach ${this.url}: ${reason}`);
         }
-        const text = await res.text();
-        if (!res.ok) {
-            let message;
-            try {
-                message = JSON.parse(text).error;
-                if (typeof message !== "string")
-                    throw new Error();
-            }
-            catch {
-                message = `HTTP ${res.status}: ${text.slice(0, 200).replace(/\s+/g, " ").trim()}`;
-            }
-            throw new (ERRORS[res.status] ?? NotefeedError)(message, res.status);
+        if (response.redirected) {
+            throw new NotefeedError(`${this.url} redirected to ${new URL(response.url).origin}: use that address as the URL`, response.status);
+        }
+        if (response.ok) {
+            if (error === undefined && isObject(data))
+                return data;
+            throw new NotefeedError(`unexpected response from ${this.url} (not a notefeed server?)`, response.status);
         }
-        try {
-            const { id, url } = JSON.parse(text);
-            if (typeof id === "string" && typeof url === "string")
-                return { id, url };
+        const body = isObject(error) ? error : null;
+        const code = typeof body?.code === "string" ? body.code : null;
+        let message = typeof body?.error === "string" ? body.error : "";
+        if (!message) {
+            const raw = typeof error === "string" ? error : isObject(error) && Object.keys(error).length ? JSON.stringify(error) : "";
+            message = `HTTP ${response.status}: ${raw.slice(0, 200).replace(/\s+/g, " ").trim()}`.replace(/: $/, "");
         }
-        catch { }
-        throw new NotefeedError(`unexpected response from ${this.url} (not a notefeed server?)`, res.status);
+        if (code === "rate_limited" || code === "too_many_attempts" || response.status === 429) {
+            const retry = response.headers.get("retry-after")?.trim() ?? "";
+            throw new RateLimitedError(message, response.status, code, /^\d+$/.test(retry) ? Number(retry) : null);
+        }
+        const Cls = (code && BY_CODE[code]) || NotefeedError;
+        throw new Cls(message, response.status, code);
     }
 }
+const isObject = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
+function checkFeed(feed) {
+    // Never echo the name: it is the write key.
+    if (!FEED_RE.test(feed))
+        throw new ConfigError("invalid feed name: use 1-64 of a-z, 0-9, _ and -");
+    return feed;
+}

package/dist/generated/client/client.gen.d.ts

@@ -0,0 +1,2 @@
+import type { Client, Config } from './types.gen.js';
+export declare const createClient: (config?: Config) => Client;

package/dist/generated/client/client.gen.js

@@ -0,0 +1,216 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import { createSseClient } from '../core/serverSentEvents.gen.js';
+import { getValidRequestBody } from '../core/utils.gen.js';
+import { buildUrl, createConfig, createInterceptors, getParseAs, mergeConfigs, mergeHeaders, setAuthParams, } from './utils.gen.js';
+export const createClient = (config = {}) => {
+    let _config = mergeConfigs(createConfig(), config);
+    const getConfig = () => ({ ..._config });
+    const setConfig = (config) => {
+        _config = mergeConfigs(_config, config);
+        return getConfig();
+    };
+    const interceptors = createInterceptors();
+    const beforeRequest = async (options) => {
+        const opts = {
+            ..._config,
+            ...options,
+            fetch: options.fetch ?? _config.fetch ?? globalThis.fetch,
+            headers: mergeHeaders(_config.headers, options.headers),
+            serializedBody: undefined,
+        };
+        if (opts.security) {
+            await setAuthParams(opts);
+        }
+        if (opts.requestValidator) {
+            await opts.requestValidator(opts);
+        }
+        if (opts.body !== undefined && opts.bodySerializer) {
+            opts.serializedBody = opts.bodySerializer(opts.body);
+        }
+        // remove Content-Type header if body is empty to avoid sending invalid requests
+        if (opts.body === undefined || opts.serializedBody === '') {
+            opts.headers.delete('Content-Type');
+        }
+        const resolvedOpts = opts;
+        const url = buildUrl(resolvedOpts);
+        return { opts: resolvedOpts, url };
+    };
+    const request = async (options) => {
+        const throwOnError = options.throwOnError ?? _config.throwOnError;
+        const responseStyle = options.responseStyle ?? _config.responseStyle;
+        let request;
+        let response;
+        try {
+            const { opts, url } = await beforeRequest(options);
+            const requestInit = {
+                redirect: 'follow',
+                ...opts,
+                body: getValidRequestBody(opts),
+            };
+            request = new Request(url, requestInit);
+            for (const fn of interceptors.request.fns) {
+                if (fn) {
+                    request = await fn(request, opts);
+                }
+            }
+            // fetch must be assigned here, otherwise it would throw the error:
+            // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
+            const _fetch = opts.fetch;
+            response = await _fetch(request);
+            for (const fn of interceptors.response.fns) {
+                if (fn) {
+                    response = await fn(response, request, opts);
+                }
+            }
+            const result = {
+                request,
+                response,
+            };
+            if (response.ok) {
+                const parseAs = (opts.parseAs === 'auto'
+                    ? getParseAs(response.headers.get('Content-Type'))
+                    : opts.parseAs) ?? 'json';
+                if (response.status === 204 || response.headers.get('Content-Length') === '0') {
+                    let emptyData;
+                    switch (parseAs) {
+                        case 'arrayBuffer':
+                        case 'blob':
+                        case 'text':
+                            emptyData = await response[parseAs]();
+                            break;
+                        case 'formData':
+                            emptyData = new FormData();
+                            break;
+                        case 'stream':
+                            emptyData = response.body;
+                            break;
+                        case 'json':
+                        default:
+                            emptyData = {};
+                            break;
+                    }
+                    return opts.responseStyle === 'data'
+                        ? emptyData
+                        : {
+                            data: emptyData,
+                            ...result,
+                        };
+                }
+                let data;
+                switch (parseAs) {
+                    case 'arrayBuffer':
+                    case 'blob':
+                    case 'formData':
+                    case 'text':
+                        data = await response[parseAs]();
+                        break;
+                    case 'json': {
+                        // Some servers return 200 with no Content-Length and empty body.
+                        // response.json() would throw; read as text and parse if non-empty.
+                        const text = await response.text();
+                        data = text ? JSON.parse(text) : {};
+                        break;
+                    }
+                    case 'stream':
+                        return opts.responseStyle === 'data'
+                            ? response.body
+                            : {
+                                data: response.body,
+                                ...result,
+                            };
+                }
+                if (parseAs === 'json') {
+                    if (opts.responseValidator) {
+                        await opts.responseValidator(data);
+                    }
+                    if (opts.responseTransformer) {
+                        data = await opts.responseTransformer(data);
+                    }
+                }
+                return opts.responseStyle === 'data'
+                    ? data
+                    : {
+                        data,
+                        ...result,
+                    };
+            }
+            const textError = await response.text();
+            let jsonError;
+            try {
+                jsonError = JSON.parse(textError);
+            }
+            catch {
+                // noop
+            }
+            throw jsonError ?? textError;
+        }
+        catch (error) {
+            let finalError = error;
+            for (const fn of interceptors.error.fns) {
+                if (fn) {
+                    finalError = await fn(finalError, response, request, options);
+                }
+            }
+            finalError = finalError || {};
+            if (throwOnError) {
+                throw finalError;
+            }
+            // TODO: we probably want to return error and improve types
+            return responseStyle === 'data'
+                ? undefined
+                : {
+                    error: finalError,
+                    request,
+                    response,
+                };
+        }
+    };
+    const makeMethodFn = (method) => (options) => request({ ...options, method });
+    const makeSseFn = (method) => async (options) => {
+        const { opts, url } = await beforeRequest(options);
+        return createSseClient({
+            ...opts,
+            body: opts.body,
+            method,
+            onRequest: async (url, init) => {
+                let request = new Request(url, init);
+                for (const fn of interceptors.request.fns) {
+                    if (fn) {
+                        request = await fn(request, opts);
+                    }
+                }
+                return request;
+            },
+            serializedBody: getValidRequestBody(opts),
+            url,
+        });
+    };
+    const _buildUrl = (options) => buildUrl({ ..._config, ...options });
+    return {
+        buildUrl: _buildUrl,
+        connect: makeMethodFn('CONNECT'),
+        delete: makeMethodFn('DELETE'),
+        get: makeMethodFn('GET'),
+        getConfig,
+        head: makeMethodFn('HEAD'),
+        interceptors,
+        options: makeMethodFn('OPTIONS'),
+        patch: makeMethodFn('PATCH'),
+        post: makeMethodFn('POST'),
+        put: makeMethodFn('PUT'),
+        request,
+        setConfig,
+        sse: {
+            connect: makeSseFn('CONNECT'),
+            delete: makeSseFn('DELETE'),
+            get: makeSseFn('GET'),
+            head: makeSseFn('HEAD'),
+            options: makeSseFn('OPTIONS'),
+            patch: makeSseFn('PATCH'),
+            post: makeSseFn('POST'),
+            put: makeSseFn('PUT'),
+            trace: makeSseFn('TRACE'),
+        },
+        trace: makeMethodFn('TRACE'),
+    };
+};

package/dist/generated/client/index.d.ts

@@ -0,0 +1,10 @@
+export type { Auth } from '../core/auth.gen.js';
+export type { QuerySerializerOptions } from '../core/bodySerializer.gen.js';
+export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer, } from '../core/bodySerializer.gen.js';
+export { buildClientParams } from '../core/params.gen.js';
+export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js';
+export type { ServerSentEventsResult } from '../core/serverSentEvents.gen.js';
+export type { ClientMeta } from '../core/types.gen.js';
+export { createClient } from './client.gen.js';
+export type { Client, ClientOptions, Config, CreateClientConfig, Options, RequestOptions, RequestResult, ResolvedRequestOptions, ResponseStyle, TDataShape, } from './types.gen.js';
+export { createConfig, mergeHeaders } from './utils.gen.js';

package/dist/generated/client/index.js

@@ -0,0 +1,6 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer, } from '../core/bodySerializer.gen.js';
+export { buildClientParams } from '../core/params.gen.js';
+export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js';
+export { createClient } from './client.gen.js';
+export { createConfig, mergeHeaders } from './utils.gen.js';

package/dist/generated/client/types.gen.d.ts

@@ -0,0 +1,120 @@
+import type { Auth } from '../core/auth.gen.js';
+import type { ServerSentEventsOptions, ServerSentEventsResult } from '../core/serverSentEvents.gen.js';
+import type { Client as CoreClient, Config as CoreConfig } from '../core/types.gen.js';
+import type { Middleware } from './utils.gen.js';
+export type ResponseStyle = 'data' | 'fields';
+export interface Config<T extends ClientOptions = ClientOptions> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, CoreConfig {
+    /**
+     * Base URL for all requests made by this client.
+     */
+    baseUrl?: T['baseUrl'];
+    /**
+     * Fetch API implementation. You can use this option to provide a custom
+     * fetch instance.
+     *
+     * @default globalThis.fetch
+     */
+    fetch?: typeof fetch;
+    /**
+     * Please don't use the Fetch client for Next.js applications. The `next`
+     * options won't have any effect.
+     *
+     * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
+     */
+    next?: never;
+    /**
+     * Return the response data parsed in a specified format. By default, `auto`
+     * will infer the appropriate method from the `Content-Type` response header.
+     * You can override this behavior with any of the {@link Body} methods.
+     * Select `stream` if you don't want to parse response data at all.
+     *
+     * @default 'auto'
+     */
+    parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
+    /**
+     * Should we return only data or multiple fields (data, error, response, etc.)?
+     *
+     * @default 'fields'
+     */
+    responseStyle?: ResponseStyle;
+    /**
+     * Throw an error instead of returning it in the response?
+     *
+     * @default false
+     */
+    throwOnError?: T['throwOnError'];
+}
+export interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
+    responseStyle: TResponseStyle;
+    throwOnError: ThrowOnError;
+}>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
+    /**
+     * Any body that you want to add to your request.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
+     */
+    body?: unknown;
+    path?: Record<string, unknown>;
+    query?: Record<string, unknown>;
+    /**
+     * Security mechanism(s) to use for the request.
+     */
+    security?: ReadonlyArray<Auth>;
+    url: Url;
+}
+export interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
+    headers: Headers;
+    serializedBody?: string;
+}
+export type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
+    data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
+    request: Request;
+    response: Response;
+}> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
+    data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
+    error: undefined;
+} | {
+    data: undefined;
+    error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
+}) & {
+    /** request may be undefined, because error may be from building the request object itself */
+    request?: Request;
+    /** response may be undefined, because error may be from building the request object itself or from a network error */
+    response?: Response;
+}>;
+export interface ClientOptions {
+    baseUrl?: string;
+    responseStyle?: ResponseStyle;
+    throwOnError?: boolean;
+}
+type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type SseFn = <TData = unknown, _TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData>>;
+type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type BuildUrlFn = <TData extends {
+    body?: unknown;
+    path?: Record<string, unknown>;
+    query?: Record<string, unknown>;
+    url: string;
+}>(options: TData & Options<TData>) => string;
+export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
+    interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
+};
+/**
+ * The `createClientConfig()` function will be called on client initialization
+ * and the returned object will become the client's initial configuration.
+ *
+ * You may want to initialize your client this way instead of calling
+ * `setConfig()`. This is useful for example if you're using Next.js
+ * to ensure your client always has the correct values.
+ */
+export type CreateClientConfig<T extends ClientOptions = ClientOptions> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>;
+export interface TDataShape {
+    body?: unknown;
+    headers?: unknown;
+    path?: unknown;
+    query?: unknown;
+    url: string;
+}
+type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
+export {};

package/dist/generated/client/types.gen.js

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export {};

package/dist/generated/client/utils.gen.d.ts

@@ -0,0 +1,37 @@
+import type { QuerySerializerOptions } from '../core/bodySerializer.gen.js';
+import type { Client, ClientOptions, Config, RequestOptions } from './types.gen.js';
+export declare const createQuerySerializer: <T = unknown>({ parameters, ...args }?: QuerySerializerOptions) => ((queryParams: T) => string);
+/**
+ * Infers parseAs value from provided Content-Type header.
+ */
+export declare const getParseAs: (contentType: string | null) => Exclude<Config["parseAs"], "auto">;
+export declare function setAuthParams(options: Pick<RequestOptions, 'auth' | 'query' | 'security'> & {
+    headers: Headers;
+}): Promise<void>;
+export declare const buildUrl: Client['buildUrl'];
+export declare const mergeConfigs: (a: Config, b: Config) => Config;
+export declare const mergeHeaders: (...headers: Array<Required<Config>["headers"] | undefined>) => Headers;
+type ErrInterceptor<Err, Res, Req, Options> = (error: Err, 
+/** response may be undefined due to a network error where no response object is produced */
+response: Res | undefined, 
+/** request may be undefined, because error may be from building the request object itself */
+request: Req | undefined, options: Options) => Err | Promise<Err>;
+type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
+type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
+declare class Interceptors<Interceptor> {
+    fns: Array<Interceptor | null>;
+    clear(): void;
+    eject(id: number | Interceptor): void;
+    exists(id: number | Interceptor): boolean;
+    getInterceptorIndex(id: number | Interceptor): number;
+    update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
+    use(fn: Interceptor): number;
+}
+export interface Middleware<Req, Res, Err, Options> {
+    error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
+    request: Interceptors<ReqInterceptor<Req, Options>>;
+    response: Interceptors<ResInterceptor<Res, Req, Options>>;
+}
+export declare const createInterceptors: <Req, Res, Err, Options>() => Middleware<Req, Res, Err, Options>;
+export declare const createConfig: <T extends ClientOptions = ClientOptions>(override?: Config<Omit<ClientOptions, keyof T> & T>) => Config<Omit<ClientOptions, keyof T> & T>;
+export {};