@examplary/sdk 0.0.1

package/README.md

@@ -0,0 +1,25 @@
+# Examplary API SDK for TypeScript
+
+This package provides a TypeScript client for the Examplary API, allowing you to interact with the API in a type-safe manner. It includes methods for all API endpoints, as well as type definitions for request and response data.
+
+## Installation
+
+You can install the SDK using npm or yarn:
+
+```bash
+yarn add @examplary/sdk
+```
+
+## Usage
+
+To use the SDK, you need to create an instance of the `ExamplaryClient` class and provide your API key:
+
+```typescript
+import { createExamplaryClient } from "@examplary/sdk";
+
+const client = createExamplaryClient({
+  apiKey: "my-api-key-or-oauth-access-token",
+});
+
+const { data } = await client.questionTypes.listPublic();
+```

package/dist/generated/client/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/client.gen.js

@@ -0,0 +1,204 @@
+"use strict";
+// This file is auto-generated by @hey-api/openapi-ts
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClient = void 0;
+var axios_1 = require("axios");
+var serverSentEvents_gen_1 = require("../core/serverSentEvents.gen");
+var utils_gen_1 = require("../core/utils.gen");
+var utils_gen_2 = require("./utils.gen");
+var createClient = function (config) {
+    if (config === void 0) { config = {}; }
+    var _config = (0, utils_gen_2.mergeConfigs)((0, utils_gen_2.createConfig)(), config);
+    var instance;
+    if (_config.axios && !('Axios' in _config.axios)) {
+        instance = _config.axios;
+    }
+    else {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        var auth = _config.auth, configWithoutAuth = __rest(_config, ["auth"]);
+        instance = axios_1.default.create(configWithoutAuth);
+    }
+    var getConfig = function () { return (__assign({}, _config)); };
+    var setConfig = function (config) {
+        _config = (0, utils_gen_2.mergeConfigs)(_config, config);
+        instance.defaults = __assign(__assign(__assign({}, instance.defaults), _config), { 
+            // @ts-ignore
+            headers: (0, utils_gen_2.mergeHeaders)(instance.defaults.headers, _config.headers) });
+        return getConfig();
+    };
+    var beforeRequest = function (options) { return __awaiter(void 0, void 0, void 0, function () {
+        var opts, url;
+        var _a, _b;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    opts = __assign(__assign(__assign({}, _config), options), { axios: (_b = (_a = options.axios) !== null && _a !== void 0 ? _a : _config.axios) !== null && _b !== void 0 ? _b : instance, headers: (0, utils_gen_2.mergeHeaders)(_config.headers, options.headers) });
+                    if (!opts.security) return [3 /*break*/, 2];
+                    return [4 /*yield*/, (0, utils_gen_2.setAuthParams)(__assign(__assign({}, opts), { security: opts.security }))];
+                case 1:
+                    _c.sent();
+                    _c.label = 2;
+                case 2:
+                    if (!opts.requestValidator) return [3 /*break*/, 4];
+                    return [4 /*yield*/, opts.requestValidator(opts)];
+                case 3:
+                    _c.sent();
+                    _c.label = 4;
+                case 4:
+                    if (opts.body !== undefined && opts.bodySerializer) {
+                        opts.body = opts.bodySerializer(opts.body);
+                    }
+                    url = (0, utils_gen_2.buildUrl)(opts);
+                    return [2 /*return*/, { opts: opts, url: url }];
+            }
+        });
+    }); };
+    // @ts-ignore
+    var request = function (options) { return __awaiter(void 0, void 0, void 0, function () {
+        var _a, opts, url, _axios, auth, optsWithoutAuth, response, data, error_1, e;
+        var _b, _c;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
+                case 0: return [4 /*yield*/, beforeRequest(options)];
+                case 1:
+                    _a = _d.sent(), opts = _a.opts, url = _a.url;
+                    _d.label = 2;
+                case 2:
+                    _d.trys.push([2, 8, , 9]);
+                    _axios = opts.axios;
+                    auth = opts.auth, optsWithoutAuth = __rest(opts, ["auth"]);
+                    return [4 /*yield*/, _axios(__assign(__assign({}, optsWithoutAuth), { baseURL: '', 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: url }))];
+                case 3:
+                    response = _d.sent();
+                    data = response.data;
+                    if (!(opts.responseType === 'json')) return [3 /*break*/, 7];
+                    if (!opts.responseValidator) return [3 /*break*/, 5];
+                    return [4 /*yield*/, opts.responseValidator(data)];
+                case 4:
+                    _d.sent();
+                    _d.label = 5;
+                case 5:
+                    if (!opts.responseTransformer) return [3 /*break*/, 7];
+                    return [4 /*yield*/, opts.responseTransformer(data)];
+                case 6:
+                    data = _d.sent();
+                    _d.label = 7;
+                case 7: return [2 /*return*/, __assign(__assign({}, response), { data: data !== null && data !== void 0 ? data : {} })];
+                case 8:
+                    error_1 = _d.sent();
+                    e = error_1;
+                    if (opts.throwOnError) {
+                        throw e;
+                    }
+                    // @ts-ignore
+                    e.error = (_c = (_b = e.response) === null || _b === void 0 ? void 0 : _b.data) !== null && _c !== void 0 ? _c : {};
+                    return [2 /*return*/, e];
+                case 9: return [2 /*return*/];
+            }
+        });
+    }); };
+    var makeMethodFn = function (method) { return function (options) {
+        return request(__assign(__assign({}, options), { method: method }));
+    }; };
+    var makeSseFn = function (method) { return function (options) { return __awaiter(void 0, void 0, void 0, function () {
+        var _a, opts, url;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, beforeRequest(options)];
+                case 1:
+                    _a = _b.sent(), opts = _a.opts, url = _a.url;
+                    return [2 /*return*/, (0, serverSentEvents_gen_1.createSseClient)(__assign(__assign({}, opts), { body: opts.body, headers: opts.headers, method: method, serializedBody: (0, utils_gen_1.getValidRequestBody)(opts), 
+                            // @ts-ignore
+                            signal: opts.signal, url: url }))];
+            }
+        });
+    }); }; };
+    return {
+        buildUrl: utils_gen_2.buildUrl,
+        connect: makeMethodFn('CONNECT'),
+        delete: makeMethodFn('DELETE'),
+        get: makeMethodFn('GET'),
+        getConfig: getConfig,
+        head: makeMethodFn('HEAD'),
+        instance: instance,
+        options: makeMethodFn('OPTIONS'),
+        patch: makeMethodFn('PATCH'),
+        post: makeMethodFn('POST'),
+        put: makeMethodFn('PUT'),
+        request: request,
+        setConfig: 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

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

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

@@ -0,0 +1,16 @@
+"use strict";
+// This file is auto-generated by @hey-api/openapi-ts
+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

@@ -0,0 +1,88 @@
+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>, '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<TData, 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 {
+    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> & {
+    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/types.gen.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file is auto-generated by @hey-api/openapi-ts
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,14 @@
+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>;