@raconte/node-sdk 0.1.0

package/README.md

@@ -0,0 +1,64 @@
+# @raconte/node-sdk
+
+Typed TypeScript SDK for the public [Raconte](https://raconte.ai) API: create and manage AI voice interviews and their invitations.
+
+The SDK is generated from the public OpenAPI spec (the routes authenticated with an organization API key, the same surface exposed by the MCP server). It uses the native `fetch`, ships ESM, and works in Node and any modern runtime.
+
+## Install
+
+```bash
+npm install @raconte/node-sdk
+# or: pnpm add @raconte/node-sdk
+```
+
+## Authentication
+
+Create an organization API key in **Settings, API** on raconte.ai. Pass it to `createRaconteClient`:
+
+```ts
+import { createRaconteClient, interviewsControllerList } from '@raconte/node-sdk'
+
+const client = createRaconteClient({ apiKey: process.env.RACONTE_API_KEY! })
+
+const { data, error } = await interviewsControllerList({ client })
+if (error)
+  throw new Error(`Request failed: ${JSON.stringify(error)}`)
+
+console.log(data)
+```
+
+Every SDK function takes the client through its `client` option. Calls return `{ data, error, response }` (no throw on HTTP errors); check `error` before using `data`.
+
+## What you can do
+
+The SDK covers interviews, their invitations and the voice catalog:
+
+- **Interviews**: list, create, get, update, archive, restore, logs, regenerate intro / first message.
+- **Invitations**: list, create, create in bulk, get, update, send, cancel, reactivate, archive, restore, logs, get a message audio URL.
+- **Voices**: list the catalog and get a preview audio URL (the public, no-auth endpoints you pick a `voiceId` from).
+
+Function names mirror the API operation IDs, for example `interviewsControllerCreate`, `interviewInvitationsControllerSend`.
+
+## Validation schemas
+
+Zod schemas for every request and response are available from the `/zod` subpath:
+
+```ts
+import { zCreateInterviewSchema } from '@raconte/node-sdk/zod'
+
+const input = zCreateInterviewSchema.parse(payload)
+```
+
+## Generation
+
+This package is generated, do not edit `src/generated/`. The source is the public OpenAPI snapshot at `apps/website/public/openapi.json`. Regenerate from the repo root:
+
+```bash
+pnpm generate
+```
+
+which refreshes the public spec and then this SDK. To regenerate only the SDK from the current snapshot:
+
+```bash
+pnpm --filter @raconte/node-sdk generate
+```

package/dist/client.d.ts

@@ -0,0 +1,23 @@
+import type { Client } from './generated/client';
+/** Default origin of the Raconte API. */
+export declare const RACONTE_API_BASE_URL = "https://api.raconte.ai";
+export interface RaconteClientOptions {
+    /** Organization API key. Create one in Settings, API. */
+    apiKey: string;
+    /** Override the API origin. Defaults to the Raconte API. */
+    baseUrl?: string;
+}
+/**
+ * Creates a Raconte API client authenticated with an organization API key.
+ *
+ * The key is sent as `Authorization: Bearer <key>`. Pass the returned client to any SDK
+ * function through its `client` option:
+ *
+ * ```ts
+ * import { createRaconteClient, interviewsControllerList } from '@raconte/node-sdk'
+ *
+ * const client = createRaconteClient({ apiKey: process.env.RACONTE_API_KEY! })
+ * const { data } = await interviewsControllerList({ client })
+ * ```
+ */
+export declare function createRaconteClient(options: RaconteClientOptions): Client;

package/dist/client.js

@@ -0,0 +1,23 @@
+import { createClient, createConfig } from './generated/client';
+/** Default origin of the Raconte API. */
+export const RACONTE_API_BASE_URL = 'https://api.raconte.ai';
+/**
+ * Creates a Raconte API client authenticated with an organization API key.
+ *
+ * The key is sent as `Authorization: Bearer <key>`. Pass the returned client to any SDK
+ * function through its `client` option:
+ *
+ * ```ts
+ * import { createRaconteClient, interviewsControllerList } from '@raconte/node-sdk'
+ *
+ * const client = createRaconteClient({ apiKey: process.env.RACONTE_API_KEY! })
+ * const { data } = await interviewsControllerList({ client })
+ * ```
+ */
+export function createRaconteClient(options) {
+    const { apiKey, baseUrl = RACONTE_API_BASE_URL } = options;
+    return createClient(createConfig({
+        baseUrl,
+        headers: { Authorization: `Bearer ${apiKey}` },
+    }));
+}

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

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

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

@@ -0,0 +1,229 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import { createSseClient } from "../core/serverSentEvents.gen";
+import { getValidRequestBody } from "../core/utils.gen";
+import { buildUrl, createConfig, createInterceptors, getParseAs, mergeConfigs, mergeHeaders, setAuthParams, } from "./utils.gen";
+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,
+                security: opts.security,
+            });
+        }
+        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 url = buildUrl(opts);
+        return { opts, url };
+    };
+    const request = async (options) => {
+        // @ts-expect-error
+        const { opts, url } = await beforeRequest(options);
+        const requestInit = {
+            redirect: "follow",
+            ...opts,
+            body: getValidRequestBody(opts),
+        };
+        let 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;
+        let response;
+        try {
+            response = await _fetch(request);
+        }
+        catch (error) {
+            // Handle fetch exceptions (AbortError, network errors, etc.)
+            let finalError = error;
+            for (const fn of interceptors.error.fns) {
+                if (fn) {
+                    finalError = (await fn(error, undefined, request, opts));
+                }
+            }
+            finalError = finalError || {};
+            if (opts.throwOnError) {
+                throw finalError;
+            }
+            // Return error response
+            return opts.responseStyle === "data"
+                ? undefined
+                : {
+                    error: finalError,
+                    request,
+                    response: undefined,
+                };
+        }
+        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 "json":
+                case "text":
+                    data = await response[parseAs]();
+                    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
+        }
+        const error = jsonError ?? textError;
+        let finalError = error;
+        for (const fn of interceptors.error.fns) {
+            if (fn) {
+                finalError = (await fn(error, response, request, opts));
+            }
+        }
+        finalError = finalError || {};
+        if (opts.throwOnError) {
+            throw finalError;
+        }
+        // TODO: we probably want to return error and improve types
+        return opts.responseStyle === "data"
+            ? undefined
+            : {
+                error: finalError,
+                ...result,
+            };
+    };
+    const makeMethodFn = (method) => (options) => request({ ...options, method });
+    const makeSseFn = (method) => async (options) => {
+        const { opts, url } = await beforeRequest(options);
+        return createSseClient({
+            ...opts,
+            body: opts.body,
+            headers: opts.headers,
+            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,
+        });
+    };
+    return {
+        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,8 @@
+export type { Auth } from "../core/auth.gen";
+export type { QuerySerializerOptions } from "../core/bodySerializer.gen";
+export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer, } from "../core/bodySerializer.gen";
+export { buildClientParams } from "../core/params.gen";
+export { serializeQueryKeyValue } from "../core/queryKeySerializer.gen";
+export { createClient } from "./client.gen";
+export type { Client, ClientOptions, Config, CreateClientConfig, Options, RequestOptions, RequestResult, ResolvedRequestOptions, ResponseStyle, TDataShape, } from "./types.gen";
+export { createConfig, mergeHeaders } from "./utils.gen";

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";
+export { buildClientParams } from "../core/params.gen";
+export { serializeQueryKeyValue } from "../core/queryKeySerializer.gen";
+export { createClient } from "./client.gen";
+export { createConfig, mergeHeaders } from "./utils.gen";

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

@@ -0,0 +1,117 @@
+import type { Auth } from "../core/auth.gen";
+import type { ServerSentEventsOptions, ServerSentEventsResult } from "../core/serverSentEvents.gen";
+import type { Client as CoreClient, Config as CoreConfig } from "../core/types.gen";
+import type { Middleware } from "./utils.gen";
+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>, "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> {
+    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: Request;
+    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<TData, TResponseStyle, ThrowOnError>, "method">) => Promise<ServerSentEventsResult<TData, TError>>;
+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,33 @@
+import type { QuerySerializerOptions } from "../core/bodySerializer.gen";
+import type { Client, ClientOptions, Config, RequestOptions } from "./types.gen";
+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 const setAuthParams: ({ security, ...options }: Pick<Required<RequestOptions>, "security"> & Pick<RequestOptions, "auth" | "query"> & {
+    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: Res, request: Req, 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 {};