@examplary/sdk 1.0.3 → 1.1.0

package/dist/generated/{client/client/types.gen.js → types.js}

@@ -1,3 +1,3 @@
 "use strict";
-// This file is auto-generated based on the Examplary API schema.
+// This file is auto-generated. Do not edit by hand.
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/context.d.ts

@@ -0,0 +1,7 @@
+import { type AxiosInstance } from "axios";
+import type { ExamplaryClientOptions } from "./options";
+export interface ClientContext {
+    axios: AxiosInstance;
+    apiKey: string;
+}
+export declare const createClientContext: (options: ExamplaryClientOptions) => ClientContext;

package/dist/src/context.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClientContext = void 0;
+const axios_1 = __importDefault(require("axios"));
+const error_1 = require("./error");
+const createClientContext = (options) => {
+    const { apiKey, baseUrl, headers, ...rest } = options;
+    const instance = axios_1.default.create({
+        baseURL: baseUrl ?? "https://api.examplary.ai",
+        ...rest,
+        headers: {
+            Authorization: `Bearer ${apiKey}`,
+            ...headers,
+        },
+    });
+    instance.interceptors.response.use((response) => response, (error) => Promise.reject(error_1.ExamplaryError.fromAxiosError(error)));
+    return { axios: instance, apiKey };
+};
+exports.createClientContext = createClientContext;

package/dist/src/error.d.ts

@@ -0,0 +1,6 @@
+import { AxiosError, type AxiosResponse, type InternalAxiosRequestConfig } from "axios";
+export declare class ExamplaryError<T = unknown, D = any> extends AxiosError<T, D> {
+    originalMessage?: string;
+    constructor(message?: string, code?: string, config?: InternalAxiosRequestConfig<D>, request?: any, response?: AxiosResponse<T, D>);
+    static fromAxiosError(error: AxiosError): ExamplaryError;
+}

package/dist/src/error.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExamplaryError = void 0;
+const axios_1 = require("axios");
+class ExamplaryError extends axios_1.AxiosError {
+    constructor(message, code, config, request, response) {
+        super(message, code, config, request, response);
+        this.name = "ExamplaryError";
+    }
+    static fromAxiosError(error) {
+        const e = new ExamplaryError(error.message, error.code, error.config, error.request, error.response);
+        const data = error.response?.data;
+        if (typeof data?.error === "string") {
+            e.originalMessage = error.message;
+            e.message = data.error;
+        }
+        else if (typeof data?.error?.message === "string") {
+            e.originalMessage = error.message;
+            e.message = data.error.message;
+        }
+        return e;
+    }
+}
+exports.ExamplaryError = ExamplaryError;

package/dist/src/index.d.ts

@@ -1,14 +1,5 @@
-import { AxiosError, AxiosResponse, InternalAxiosRequestConfig } from "axios";
-import { Examplary } from "../generated/client";
-import { Config } from "../generated/client/client";
-export type * from "../generated/client";
-export type ExamplaryClientOptions = {
-    apiKey: string;
-    baseUrl?: string;
-} & Partial<Omit<Config, "baseURL">>;
-export declare class ExamplaryClientError<T = unknown, D = any> extends AxiosError {
-    originalMessage?: string;
-    constructor(message?: string, code?: string, config?: InternalAxiosRequestConfig<D>, request?: any, response?: AxiosResponse<T, D>);
-    static fromAxiosError(error: AxiosError): ExamplaryClientError;
-}
-export declare const createExamplaryClient: (options: ExamplaryClientOptions) => Examplary;
+export { Examplary } from "../generated/sdk";
+export type * from "../generated/sdk";
+export { ExamplaryError } from "./error";
+export type { ExamplaryClientOptions, ExamplaryRequestOptions, } from "./options";
+export type { components, operations, paths } from "../generated/types";

package/dist/src/index.js

@@ -1,47 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createExamplaryClient = exports.ExamplaryClientError = void 0;
-const axios_1 = require("axios");
-const client_1 = require("../generated/client");
-const client_2 = require("../generated/client/client");
-class ExamplaryClientError extends axios_1.AxiosError {
-    constructor(message, code, config, request, response) {
-        super(message, code, config, request, response);
-        this.name = "ExamplaryClientError";
-    }
-    static fromAxiosError(error) {
-        const e = new ExamplaryClientError(error.message, error.code, error.config, error.request, error.response);
-        const responseData = error.response?.data;
-        if (responseData?.error) {
-            if (typeof responseData.error === "string") {
-                e.originalMessage = error.message;
-                e.message = responseData.error;
-            }
-            else if (responseData.error?.message &&
-                typeof responseData.error.message === "string") {
-                e.originalMessage = error.message;
-                e.message = responseData.error.message;
-            }
-        }
-        return e;
-    }
-}
-exports.ExamplaryClientError = ExamplaryClientError;
-const createExamplaryClient = (options) => {
-    const { apiKey, baseUrl, ...rest } = options;
-    const client = (0, client_2.createClient)({
-        baseURL: baseUrl || "https://api.examplary.ai",
-        ...rest,
-        headers: {
-            Authorization: apiKey ? `Bearer ${apiKey}` : undefined,
-            ...rest.headers,
-        },
-    });
-    client.instance.interceptors.response.use((response) => Promise.resolve(response), (error) => {
-        return Promise.reject(ExamplaryClientError.fromAxiosError(error));
-    });
-    return new client_1.Examplary({
-        client,
-    });
-};
-exports.createExamplaryClient = createExamplaryClient;
+exports.ExamplaryError = exports.Examplary = void 0;
+var sdk_1 = require("../generated/sdk");
+Object.defineProperty(exports, "Examplary", { enumerable: true, get: function () { return sdk_1.Examplary; } });
+var error_1 = require("./error");
+Object.defineProperty(exports, "ExamplaryError", { enumerable: true, get: function () { return error_1.ExamplaryError; } });

package/dist/src/options.d.ts

@@ -0,0 +1,6 @@
+import type { AxiosRequestConfig, CreateAxiosDefaults } from "axios";
+export interface ExamplaryClientOptions extends Omit<CreateAxiosDefaults, "baseURL"> {
+    apiKey: string;
+    baseUrl?: string;
+}
+export type ExamplaryRequestOptions = Omit<AxiosRequestConfig, "method" | "url" | "data" | "params" | "baseURL">;

package/dist/{generated/client/core/types.gen.js → src/options.js}

@@ -1,3 +1,2 @@
 "use strict";
-// This file is auto-generated based on the Examplary API schema.
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/request.d.ts

@@ -0,0 +1,3 @@
+import type { ClientContext } from "./context";
+import type { ExamplaryRequestOptions } from "./options";
+export declare const request: <T>(ctx: ClientContext, method: string, pathTemplate: string, pathKeys: readonly string[], queryKeys: readonly string[], hasBody: boolean, args: Record<string, unknown> | undefined, options: ExamplaryRequestOptions | undefined) => Promise<T>;

package/dist/src/request.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.request = void 0;
+const error_1 = require("./error");
+const API_KEY_REGEX = /^examp_[A-Za-z0-9]+$/;
+const request = async (ctx, method, pathTemplate, pathKeys, queryKeys, hasBody, args, options) => {
+    if (!API_KEY_REGEX.test(ctx.apiKey)) {
+        throw new error_1.ExamplaryError("Invalid API key");
+    }
+    const flat = args ?? {};
+    const url = pathTemplate.replace(/\{(\w+)\}/g, (_, key) => {
+        const value = flat[key];
+        if (value === undefined || value === null) {
+            throw new error_1.ExamplaryError(`Missing required path parameter "${key}"`);
+        }
+        return encodeURIComponent(String(value));
+    });
+    const params = {};
+    for (const k of queryKeys) {
+        if (flat[k] !== undefined)
+            params[k] = flat[k];
+    }
+    let data;
+    if (hasBody) {
+        const consumed = new Set([...pathKeys, ...queryKeys]);
+        const body = {};
+        let any = false;
+        for (const [k, v] of Object.entries(flat)) {
+            if (consumed.has(k))
+                continue;
+            body[k] = v;
+            any = true;
+        }
+        if (any)
+            data = body;
+    }
+    const response = await ctx.axios.request({
+        ...options,
+        method,
+        url,
+        params: Object.keys(params).length ? params : undefined,
+        data,
+    });
+    return response.data;
+};
+exports.request = request;

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "@examplary/sdk",
   "packageManager": "yarn@4.13.0",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "TypeScript SDK for accessing the Examplary API.",
   "scripts": {
-    "build:client": "openapi-ts",
+    "clean": "rm -rf dist",
+    "build:client": "tsx scripts/generate-sdk.ts",
     "build:tsc": "tsc",
-    "build": "yarn build:client && yarn build:tsc",
-    "release": "yarn remove @hey-api/openapi-ts tsx typescript vitest && npm publish",
-    "test": "vitest"
+    "build": "yarn clean && yarn build:client && yarn build:tsc",
+    "prepublishOnly": "yarn build",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit"
   },
   "files": [
     "dist"
@@ -18,10 +20,16 @@
   },
   "main": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",
-  "dependencies": {
-    "axios": "^1.15.0",
+  "devDependencies": {
+    "@types/node": "^25.6.0",
     "openapi-typescript": "^7.13.0",
-    "zod": "^4.3.6"
+    "semantic-release": "^25.0.3",
+    "tsx": "^4.21.0",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.5"
+  },
+  "dependencies": {
+    "axios": "^1.16.0"
   },
   "homepage": "https://developers.examplary.ai/",
   "author": {

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

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

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

@@ -1,140 +0,0 @@
-"use strict";
-// This file is auto-generated based on the Examplary API schema.
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createClient = void 0;
-const axios_1 = __importDefault(require("axios"));
-const serverSentEvents_gen_1 = require("../core/serverSentEvents.gen");
-const utils_gen_1 = require("../core/utils.gen");
-const utils_gen_2 = require("./utils.gen");
-const createClient = (config = {}) => {
-    let _config = (0, utils_gen_2.mergeConfigs)((0, utils_gen_2.createConfig)(), config);
-    let instance;
-    if (_config.axios && !('Axios' in _config.axios)) {
-        instance = _config.axios;
-    }
-    else {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        const { auth, ...configWithoutAuth } = _config;
-        instance = axios_1.default.create(configWithoutAuth);
-    }
-    const getConfig = () => ({ ..._config });
-    const setConfig = (config) => {
-        _config = (0, utils_gen_2.mergeConfigs)(_config, config);
-        instance.defaults = {
-            ...instance.defaults,
-            ..._config,
-            // @ts-expect-error
-            headers: (0, utils_gen_2.mergeHeaders)(instance.defaults.headers, _config.headers),
-        };
-        return getConfig();
-    };
-    const beforeRequest = async (options) => {
-        const opts = {
-            ..._config,
-            ...options,
-            axios: options.axios ?? _config.axios ?? instance,
-            headers: (0, utils_gen_2.mergeHeaders)(_config.headers, options.headers),
-        };
-        if (opts.security) {
-            await (0, utils_gen_2.setAuthParams)({
-                ...opts,
-                security: opts.security,
-            });
-        }
-        if (opts.requestValidator) {
-            await opts.requestValidator(opts);
-        }
-        if (opts.body !== undefined && opts.bodySerializer) {
-            opts.body = opts.bodySerializer(opts.body);
-        }
-        const url = (0, utils_gen_2.buildUrl)(opts);
-        return { opts, url };
-    };
-    // @ts-expect-error
-    const request = async (options) => {
-        const { opts, url } = await beforeRequest(options);
-        try {
-            // assign Axios here for consistency with fetch
-            const _axios = opts.axios;
-            // eslint-disable-next-line @typescript-eslint/no-unused-vars
-            const { auth, ...optsWithoutAuth } = opts;
-            const response = await _axios({
-                ...optsWithoutAuth,
-                baseURL: '', // the baseURL is already included in `url`
-                data: (0, utils_gen_1.getValidRequestBody)(opts),
-                headers: opts.headers,
-                // let `paramsSerializer()` handle query params if it exists
-                params: opts.paramsSerializer ? opts.query : undefined,
-                url,
-            });
-            let { data } = response;
-            if (opts.responseType === 'json') {
-                if (opts.responseValidator) {
-                    await opts.responseValidator(data);
-                }
-                if (opts.responseTransformer) {
-                    data = await opts.responseTransformer(data);
-                }
-            }
-            return {
-                ...response,
-                data: data ?? {},
-            };
-        }
-        catch (error) {
-            const e = error;
-            if (opts.throwOnError) {
-                throw e;
-            }
-            // @ts-expect-error
-            e.error = e.response?.data ?? {};
-            return e;
-        }
-    };
-    const makeMethodFn = (method) => (options) => request({ ...options, method });
-    const makeSseFn = (method) => async (options) => {
-        const { opts, url } = await beforeRequest(options);
-        return (0, serverSentEvents_gen_1.createSseClient)({
-            ...opts,
-            body: opts.body,
-            headers: opts.headers,
-            method,
-            serializedBody: (0, utils_gen_1.getValidRequestBody)(opts),
-            // @ts-expect-error
-            signal: opts.signal,
-            url,
-        });
-    };
-    const _buildUrl = (options) => (0, utils_gen_2.buildUrl)({ axios: instance, ..._config, ...options });
-    return {
-        buildUrl: _buildUrl,
-        connect: makeMethodFn('CONNECT'),
-        delete: makeMethodFn('DELETE'),
-        get: makeMethodFn('GET'),
-        getConfig,
-        head: makeMethodFn('HEAD'),
-        instance,
-        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'),
-    };
-};
-exports.createClient = createClient;

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

@@ -1,8 +0,0 @@
-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, TDataShape, } from './types.gen';
-export { createConfig } from './utils.gen';

package/dist/generated/client/client/index.js

@@ -1,16 +0,0 @@
-"use strict";
-// This file is auto-generated based on the Examplary API schema.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createConfig = exports.createClient = exports.serializeQueryKeyValue = exports.buildClientParams = exports.urlSearchParamsBodySerializer = exports.jsonBodySerializer = exports.formDataBodySerializer = void 0;
-var bodySerializer_gen_1 = require("../core/bodySerializer.gen");
-Object.defineProperty(exports, "formDataBodySerializer", { enumerable: true, get: function () { return bodySerializer_gen_1.formDataBodySerializer; } });
-Object.defineProperty(exports, "jsonBodySerializer", { enumerable: true, get: function () { return bodySerializer_gen_1.jsonBodySerializer; } });
-Object.defineProperty(exports, "urlSearchParamsBodySerializer", { enumerable: true, get: function () { return bodySerializer_gen_1.urlSearchParamsBodySerializer; } });
-var params_gen_1 = require("../core/params.gen");
-Object.defineProperty(exports, "buildClientParams", { enumerable: true, get: function () { return params_gen_1.buildClientParams; } });
-var queryKeySerializer_gen_1 = require("../core/queryKeySerializer.gen");
-Object.defineProperty(exports, "serializeQueryKeyValue", { enumerable: true, get: function () { return queryKeySerializer_gen_1.serializeQueryKeyValue; } });
-var client_gen_1 = require("./client.gen");
-Object.defineProperty(exports, "createClient", { enumerable: true, get: function () { return client_gen_1.createClient; } });
-var utils_gen_1 = require("./utils.gen");
-Object.defineProperty(exports, "createConfig", { enumerable: true, get: function () { return utils_gen_1.createConfig; } });

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

@@ -1,87 +0,0 @@
-import type { AxiosError, AxiosInstance, AxiosRequestHeaders, AxiosResponse, AxiosStatic, CreateAxiosDefaults } from 'axios';
-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';
-export interface Config<T extends ClientOptions = ClientOptions> extends Omit<CreateAxiosDefaults, 'auth' | 'baseURL' | 'headers' | 'method'>, CoreConfig {
-    /**
-     * Axios implementation. You can use this option to provide either an
-     * `AxiosStatic` or an `AxiosInstance`.
-     *
-     * @default axios
-     */
-    axios?: AxiosStatic | AxiosInstance;
-    /**
-     * Base URL for all requests made by this client.
-     */
-    baseURL?: T['baseURL'];
-    /**
-     * An object containing any HTTP headers that you want to pre-populate your
-     * `Headers` object with.
-     *
-     * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
-     */
-    headers?: AxiosRequestHeaders | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
-    /**
-     * Throw an error instead of returning it in the response?
-     *
-     * @default false
-     */
-    throwOnError?: T['throwOnError'];
-}
-export interface RequestOptions<TData = unknown, ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
-    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 ClientOptions {
-    baseURL?: string;
-    throwOnError?: boolean;
-}
-export type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean> = ThrowOnError extends true ? Promise<AxiosResponse<TData extends Record<string, unknown> ? TData[keyof TData] : TData>> : Promise<(AxiosResponse<TData extends Record<string, unknown> ? TData[keyof TData] : TData> & {
-    error: undefined;
-}) | (AxiosError<TError extends Record<string, unknown> ? TError[keyof TError] : TError> & {
-    data: undefined;
-    error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
-})>;
-type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions<TData, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError>;
-type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions<never, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
-type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptions<TData, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError>;
-type BuildUrlFn = <TData extends {
-    path?: Record<string, unknown>;
-    query?: Record<string, unknown>;
-    url: string;
-}>(options: TData & Pick<RequestOptions<unknown, boolean>, 'axios' | 'baseURL' | 'paramsSerializer' | 'querySerializer'>) => string;
-export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
-    instance: AxiosInstance;
-};
-/**
- * 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> = OmitKeys<RequestOptions<TResponse, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
-export {};

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

@@ -1,14 +0,0 @@
-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;
-export declare const setAuthParams: ({ security, ...options }: Pick<Required<RequestOptions>, "security"> & Pick<RequestOptions, "auth" | "query"> & {
-    headers: Record<any, unknown>;
-}) => Promise<void>;
-export declare const buildUrl: Client['buildUrl'];
-export declare const mergeConfigs: (a: Config, b: Config) => Config;
-/**
- * Special Axios headers keywords allowing to set headers by request method.
- */
-export declare const axiosHeadersKeywords: readonly ["common", "delete", "get", "head", "patch", "post", "put"];
-export declare const mergeHeaders: (...headers: Array<Required<Config>["headers"] | undefined>) => Record<any, unknown>;
-export declare const createConfig: <T extends ClientOptions = ClientOptions>(override?: Config<Omit<ClientOptions, keyof T> & T>) => Config<Omit<ClientOptions, keyof T> & T>;