@takaro/apiclient 0.0.0-dev.fdd3e46 → 0.0.0-dev.fe2b054

package/src/generated/base.ts

@@ -1,91 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Takaro API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 0.0.0
- * Contact: support@takaro.io
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-import type { Configuration } from './configuration.js';
-// Some imports not used depending on template conditions
-// @ts-ignore
-import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
-import globalAxios from 'axios';
-
-export const BASE_PATH = 'http://localhost'.replace(/\/+$/, '');
-
-/**
- *
- * @export
- */
-export const COLLECTION_FORMATS = {
-  csv: ',',
-  ssv: ' ',
-  tsv: '\t',
-  pipes: '|',
-};
-
-/**
- *
- * @export
- * @interface RequestArgs
- */
-export interface RequestArgs {
-  url: string;
-  options: RawAxiosRequestConfig;
-}
-
-/**
- *
- * @export
- * @class BaseAPI
- */
-export class BaseAPI {
-  protected configuration: Configuration | undefined;
-
-  constructor(
-    configuration?: Configuration,
-    protected basePath: string = BASE_PATH,
-    protected axios: AxiosInstance = globalAxios,
-  ) {
-    if (configuration) {
-      this.configuration = configuration;
-      this.basePath = configuration.basePath ?? basePath;
-    }
-  }
-}
-
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
-export class RequiredError extends Error {
-  constructor(
-    public field: string,
-    msg?: string,
-  ) {
-    super(msg);
-    this.name = 'RequiredError';
-  }
-}
-
-interface ServerMap {
-  [key: string]: {
-    url: string;
-    description: string;
-  }[];
-}
-
-/**
- *
- * @export
- */
-export const operationServerMap: ServerMap = {};

package/src/generated/common.ts

@@ -1,164 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Takaro API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 0.0.0
- * Contact: support@takaro.io
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-import type { Configuration } from './configuration.js';
-import type { RequestArgs } from './base.js';
-import type { AxiosInstance, AxiosResponse } from 'axios';
-import { RequiredError } from './base.js';
-
-/**
- *
- * @export
- */
-export const DUMMY_BASE_URL = 'https://example.com';
-
-/**
- *
- * @throws {RequiredError}
- * @export
- */
-export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
-  if (paramValue === null || paramValue === undefined) {
-    throw new RequiredError(
-      paramName,
-      `Required parameter ${paramName} was null or undefined when calling ${functionName}.`,
-    );
-  }
-};
-
-/**
- *
- * @export
- */
-export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
-  if (configuration && configuration.apiKey) {
-    const localVarApiKeyValue =
-      typeof configuration.apiKey === 'function'
-        ? await configuration.apiKey(keyParamName)
-        : await configuration.apiKey;
-    object[keyParamName] = localVarApiKeyValue;
-  }
-};
-
-/**
- *
- * @export
- */
-export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
-  if (configuration && (configuration.username || configuration.password)) {
-    object['auth'] = { username: configuration.username, password: configuration.password };
-  }
-};
-
-/**
- *
- * @export
- */
-export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
-  if (configuration && configuration.accessToken) {
-    const accessToken =
-      typeof configuration.accessToken === 'function'
-        ? await configuration.accessToken()
-        : await configuration.accessToken;
-    object['Authorization'] = 'Bearer ' + accessToken;
-  }
-};
-
-/**
- *
- * @export
- */
-export const setOAuthToObject = async function (
-  object: any,
-  name: string,
-  scopes: string[],
-  configuration?: Configuration,
-) {
-  if (configuration && configuration.accessToken) {
-    const localVarAccessTokenValue =
-      typeof configuration.accessToken === 'function'
-        ? await configuration.accessToken(name, scopes)
-        : await configuration.accessToken;
-    object['Authorization'] = 'Bearer ' + localVarAccessTokenValue;
-  }
-};
-
-function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ''): void {
-  if (parameter == null) return;
-  if (typeof parameter === 'object') {
-    if (Array.isArray(parameter)) {
-      (parameter as any[]).forEach((item) => setFlattenedQueryParams(urlSearchParams, item, key));
-    } else {
-      Object.keys(parameter).forEach((currentKey) =>
-        setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`),
-      );
-    }
-  } else {
-    if (urlSearchParams.has(key)) {
-      urlSearchParams.append(key, parameter);
-    } else {
-      urlSearchParams.set(key, parameter);
-    }
-  }
-}
-
-/**
- *
- * @export
- */
-export const setSearchParams = function (url: URL, ...objects: any[]) {
-  const searchParams = new URLSearchParams(url.search);
-  setFlattenedQueryParams(searchParams, objects);
-  url.search = searchParams.toString();
-};
-
-/**
- *
- * @export
- */
-export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
-  const nonString = typeof value !== 'string';
-  const needsSerialization =
-    nonString && configuration && configuration.isJsonMime
-      ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
-      : nonString;
-  return needsSerialization ? JSON.stringify(value !== undefined ? value : {}) : value || '';
-};
-
-/**
- *
- * @export
- */
-export const toPathString = function (url: URL) {
-  return url.pathname + url.search + url.hash;
-};
-
-/**
- *
- * @export
- */
-export const createRequestFunction = function (
-  axiosArgs: RequestArgs,
-  globalAxios: AxiosInstance,
-  BASE_PATH: string,
-  configuration?: Configuration,
-) {
-  return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
-    const axiosRequestArgs = {
-      ...axiosArgs.options,
-      url: (axios.defaults.baseURL ? '' : (configuration?.basePath ?? basePath)) + axiosArgs.url,
-    };
-    return axios.request<T, R>(axiosRequestArgs);
-  };
-};

package/src/generated/configuration.ts

@@ -1,123 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Takaro API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 0.0.0
- * Contact: support@takaro.io
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-export interface ConfigurationParameters {
-  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-  username?: string;
-  password?: string;
-  accessToken?:
-    | string
-    | Promise<string>
-    | ((name?: string, scopes?: string[]) => string)
-    | ((name?: string, scopes?: string[]) => Promise<string>);
-  basePath?: string;
-  serverIndex?: number;
-  baseOptions?: any;
-  formDataCtor?: new () => any;
-}
-
-export class Configuration {
-  /**
-   * parameter for apiKey security
-   * @param name security name
-   * @memberof Configuration
-   */
-  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-  /**
-   * parameter for basic security
-   *
-   * @type {string}
-   * @memberof Configuration
-   */
-  username?: string;
-  /**
-   * parameter for basic security
-   *
-   * @type {string}
-   * @memberof Configuration
-   */
-  password?: string;
-  /**
-   * parameter for oauth2 security
-   * @param name security name
-   * @param scopes oauth2 scope
-   * @memberof Configuration
-   */
-  accessToken?:
-    | string
-    | Promise<string>
-    | ((name?: string, scopes?: string[]) => string)
-    | ((name?: string, scopes?: string[]) => Promise<string>);
-  /**
-   * override base path
-   *
-   * @type {string}
-   * @memberof Configuration
-   */
-  basePath?: string;
-  /**
-   * override server index
-   *
-   * @type {number}
-   * @memberof Configuration
-   */
-  serverIndex?: number;
-  /**
-   * base options for axios calls
-   *
-   * @type {any}
-   * @memberof Configuration
-   */
-  baseOptions?: any;
-  /**
-   * The FormData constructor that will be used to create multipart form data
-   * requests. You can inject this here so that execution environments that
-   * do not support the FormData class can still run the generated client.
-   *
-   * @type {new () => FormData}
-   */
-  formDataCtor?: new () => any;
-
-  constructor(param: ConfigurationParameters = {}) {
-    this.apiKey = param.apiKey;
-    this.username = param.username;
-    this.password = param.password;
-    this.accessToken = param.accessToken;
-    this.basePath = param.basePath;
-    this.serverIndex = param.serverIndex;
-    this.baseOptions = {
-      headers: {
-        ...param.baseOptions?.headers,
-        'User-Agent': 'OpenAPI-Generator/typescript-axios',
-      },
-      ...param.baseOptions,
-    };
-    this.formDataCtor = param.formDataCtor;
-  }
-
-  /**
-   * Check if the given MIME is a JSON MIME.
-   * JSON MIME examples:
-   *   application/json
-   *   application/json; charset=UTF8
-   *   APPLICATION/JSON
-   *   application/vnd.company+json
-   * @param mime - MIME (Multipurpose Internet Mail Extensions)
-   * @return True if the given MIME is JSON, false otherwise.
-   */
-  public isJsonMime(mime: string): boolean {
-    const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
-    return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
-  }
-}

package/src/generated/git_push.sh

@@ -1,57 +0,0 @@
-#!/bin/sh
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
-
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-git_host=$4
-
-if [ "$git_host" = "" ]; then
-    git_host="github.com"
-    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
-fi
-
-if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-
-# Initialize the local directory as a Git repository
-git init
-
-# Adds the files in the local repository and stages them for commit.
-git add .
-
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-
-# Sets the new remote
-git_remote=$(git remote)
-if [ "$git_remote" = "" ]; then # git remote not defined
-
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
-    fi
-
-fi
-
-git pull origin master
-
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'

package/src/generated/index.ts

@@ -1,16 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Takaro API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 0.0.0
- * Contact: support@takaro.io
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-export * from './api.js';
-export * from './configuration.js';

package/src/lib/__tests__/baseClient.unit.test.ts

@@ -1,17 +0,0 @@
-import { describe, it } from 'node:test';
-import { expect } from '@takaro/test';
-import { BaseApiClient, DEFAULT_REQUEST_TIMEOUT_MS } from '../baseClient.js';
-
-describe('BaseApiClient timeouts', () => {
-  it('sets a default request timeout so a stalled request cannot hang forever', () => {
-    const client = new BaseApiClient({ url: 'http://localhost:3000', log: false });
-
-    expect(client.axiosInstance.defaults.timeout).to.equal(DEFAULT_REQUEST_TIMEOUT_MS);
-  });
-
-  it('lets a caller override the timeout', () => {
-    const client = new BaseApiClient({ url: 'http://localhost:3000', log: false, timeoutMs: 5000 });
-
-    expect(client.axiosInstance.defaults.timeout).to.equal(5000);
-  });
-});

package/src/lib/adminClient.ts

@@ -1,37 +0,0 @@
-import { DomainApi } from '../generated/index.js';
-import { BaseApiClient, IBaseApiClientConfig } from './baseClient.js';
-import { AxiosInstance } from 'axios';
-
-export interface IAdminApiClientConfig extends IBaseApiClientConfig {
-  auth: {
-    clientSecret: string;
-  };
-}
-
-export class AdminClient extends BaseApiClient<IAdminApiClientConfig> {
-  constructor(config: IAdminApiClientConfig) {
-    super(config);
-    this.addAuthInterceptor(config.auth.clientSecret, this.axios);
-  }
-
-  private addAuthInterceptor(token: string, axios: AxiosInstance): AxiosInstance {
-    axios.interceptors.request.use(async (request) => {
-      if (request.url?.includes('health')) return request;
-
-      request.headers['X-Takaro-Admin-Token'] = token;
-      return request;
-    });
-
-    return axios;
-  }
-
-  get domain() {
-    return new DomainApi(
-      {
-        isJsonMime: this.isJsonMime,
-      },
-      '',
-      this.axios,
-    );
-  }
-}

package/src/lib/baseClient.ts

@@ -1,175 +0,0 @@
-import { MetaApi } from '../generated/api.js';
-import axios, { AxiosError, AxiosInstance, AxiosRequestConfig } from 'axios';
-
-/**
- * Axios defaults to NO timeout, so a request whose TCP connection stalls blocks its
- * await forever. During incident run-29688761260 a single POST hung for ~80 minutes
- * (Tempo trace 15f5708701c38676355a0e42cb9f7ffe: a client span with no server span),
- * freezing 3 of 4 CI shards until the 53-minute job timeout.
- *
- * 120s is deliberately generous — the goal is "not infinite", not "tight". The slowest
- * legitimate single call is a domain create under full 4-shard CI load at roughly 30s.
- * Individual long-running calls should pass a per-request `{ timeout }` override rather
- * than raising this.
- */
-export const DEFAULT_REQUEST_TIMEOUT_MS = 120_000;
-
-export interface IBaseApiClientConfig {
-  url: string;
-  log?: Logger | false;
-  /** Per-request timeout in ms. Defaults to DEFAULT_REQUEST_TIMEOUT_MS. */
-  timeoutMs?: number;
-}
-
-interface Logger {
-  info: (msg: string, meta?: unknown) => void;
-  warn: (msg: string, meta?: unknown) => void;
-  error: (msg: string, meta?: unknown) => void;
-  debug: (msg: string, meta?: unknown) => void;
-}
-
-export class BaseApiClient<T extends IBaseApiClientConfig> {
-  protected axios: AxiosInstance;
-  protected log: Logger = {
-    error: () => {},
-    info: () => {},
-    warn: () => {},
-    debug: () => {},
-  };
-
-  constructor(protected readonly config: T) {
-    // Browsers refuse to let JS set the User-Agent header (it's a "forbidden header").
-    // Only include it when running outside a browser context (Node.js / server-side).
-    // Use globalThis so this compiles under both DOM and non-DOM TypeScript lib targets.
-    const isBrowser =
-      typeof (globalThis as Record<string, unknown>)['window'] !== 'undefined' &&
-      typeof (globalThis as Record<string, unknown>)['document'] !== 'undefined';
-    const axiosConfig: AxiosRequestConfig = {
-      baseURL: this.config.url,
-      headers: {
-        'Content-Type': 'application/json',
-        ...(!isBrowser && { 'User-Agent': 'Takaro-API-Client' }),
-      },
-      withCredentials: true,
-      timeout: this.config.timeoutMs ?? DEFAULT_REQUEST_TIMEOUT_MS,
-    };
-    this.axios = this.addLoggers(axios.create(axiosConfig));
-
-    if (this.config.log) this.log = this.config.log;
-  }
-
-  setHeader(key: string, value: string) {
-    this.axios.defaults.headers.common[key] = value;
-  }
-
-  setDomain(domainId: string) {
-    this.axios.defaults.headers.common['X-Takaro-Domain'] = domainId;
-  }
-
-  get axiosInstance() {
-    return this.axios;
-  }
-
-  isJsonMime(mime: string) {
-    return mime === 'application/json';
-  }
-
-  private addLoggers(axios: AxiosInstance): AxiosInstance {
-    if (this.config.log === false) {
-      return axios;
-    }
-
-    axios.interceptors.request.use((request) => {
-      let prettyBody = null;
-
-      if (request.data) {
-        try {
-          prettyBody = JSON.parse(request.data);
-        } catch {
-          prettyBody = 'Could not parse body';
-        }
-      }
-
-      this.log.info(`➡️ ${request.method?.toUpperCase()} ${request.url}`, {
-        method: request.method,
-        url: request.url,
-        body: prettyBody ?? undefined,
-      });
-      return request;
-    });
-
-    axios.interceptors.response.use(
-      (response) => {
-        this.log.info(
-          `⬅️ ${response.request.method?.toUpperCase()} ${response.request.path} ${response.status} ${
-            response.statusText
-          }`,
-          {
-            status: response.status,
-            statusText: response.statusText,
-            method: response.request.method,
-            url: response.request.url,
-          },
-        );
-
-        return response;
-      },
-      (error: AxiosError) => {
-        let details = {};
-
-        if (error.response?.data) {
-          const data = error.response.data as Record<string, unknown>;
-          details = JSON.stringify(data.meta);
-        }
-
-        this.log.error('☠️ Request errored', {
-          traceId: error.response?.headers['x-trace-id'],
-          details,
-          status: error.response?.status,
-          statusText: error.response?.statusText,
-          method: error.config?.method,
-          url: error.config?.url,
-          response: error.response?.data,
-        });
-        return Promise.reject(error);
-      },
-    );
-
-    return axios;
-  }
-
-  /**
-   * Wait until the API reports that it is healthy
-   * @param timeout in milliseconds
-   */
-  async waitUntilHealthy(timeout = 600000) {
-    const start = Date.now();
-    let isHealthy = false;
-    while (!isHealthy) {
-      try {
-        const { data } = await this.meta.metaGetHealth();
-        if (data.healthy) {
-          isHealthy = true;
-        }
-      } catch {
-        // ignore
-      }
-
-      if (Date.now() - start > timeout) {
-        throw new Error('API did not become healthy in time');
-      }
-
-      await new Promise((resolve) => setTimeout(resolve, 1000));
-    }
-  }
-
-  get meta() {
-    return new MetaApi(
-      {
-        isJsonMime: this.isJsonMime,
-      },
-      '',
-      this.axios,
-    );
-  }
-}