@djangocfg/api 2.1.327 → 2.1.331

package/src/_api/generated/cfg_centrifugo/core/types.gen.ts

@@ -1,104 +0,0 @@
-// This file is auto-generated by @hey-api/openapi-ts
-
-import type { Auth, AuthToken } from './auth.gen';
-import type { BodySerializer, QuerySerializer, QuerySerializerOptions } from './bodySerializer.gen';
-
-export type HttpMethod =
-  | 'connect'
-  | 'delete'
-  | 'get'
-  | 'head'
-  | 'options'
-  | 'patch'
-  | 'post'
-  | 'put'
-  | 'trace';
-
-export type Client<
-  RequestFn = never,
-  Config = unknown,
-  MethodFn = never,
-  BuildUrlFn = never,
-  SseFn = never,
-> = {
-  /**
-   * Returns the final request URL.
-   */
-  buildUrl: BuildUrlFn;
-  getConfig: () => Config;
-  request: RequestFn;
-  setConfig: (config: Config) => Config;
-} & {
-  [K in HttpMethod]: MethodFn;
-} & ([SseFn] extends [never] ? { sse?: never } : { sse: { [K in HttpMethod]: SseFn } });
-
-export interface Config {
-  /**
-   * Auth token or a function returning auth token. The resolved value will be
-   * added to the request payload as defined by its `security` array.
-   */
-  auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
-  /**
-   * A function for serializing request body parameter. By default,
-   * {@link JSON.stringify()} will be used.
-   */
-  bodySerializer?: BodySerializer | null;
-  /**
-   * 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?:
-    | RequestInit['headers']
-    | Record<
-        string,
-        string | number | boolean | (string | number | boolean)[] | null | undefined | unknown
-      >;
-  /**
-   * The request method.
-   *
-   * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
-   */
-  method?: Uppercase<HttpMethod>;
-  /**
-   * A function for serializing request query parameters. By default, arrays
-   * will be exploded in form style, objects will be exploded in deepObject
-   * style, and reserved characters are percent-encoded.
-   *
-   * This method will have no effect if the native `paramsSerializer()` Axios
-   * API function is used.
-   *
-   * {@link https://swagger.io/docs/specification/serialization/#query View examples}
-   */
-  querySerializer?: QuerySerializer | QuerySerializerOptions;
-  /**
-   * A function validating request data. This is useful if you want to ensure
-   * the request conforms to the desired shape, so it can be safely sent to
-   * the server.
-   */
-  requestValidator?: (data: unknown) => Promise<unknown>;
-  /**
-   * A function transforming response data before it's returned. This is useful
-   * for post-processing data, e.g., converting ISO strings into Date objects.
-   */
-  responseTransformer?: (data: unknown) => Promise<unknown>;
-  /**
-   * A function validating response data. This is useful if you want to ensure
-   * the response conforms to the desired shape, so it can be safely passed to
-   * the transformers and returned to the user.
-   */
-  responseValidator?: (data: unknown) => Promise<unknown>;
-}
-
-type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never]
-  ? true
-  : [T] extends [never | undefined]
-    ? [undefined] extends [T]
-      ? false
-      : true
-    : false;
-
-export type OmitNever<T extends Record<string, unknown>> = {
-  [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true ? never : K]: T[K];
-};

package/src/_api/generated/cfg_centrifugo/core/utils.gen.ts

@@ -1,140 +0,0 @@
-// This file is auto-generated by @hey-api/openapi-ts
-
-import type { BodySerializer, QuerySerializer } from './bodySerializer.gen';
-import {
-  type ArraySeparatorStyle,
-  serializeArrayParam,
-  serializeObjectParam,
-  serializePrimitiveParam,
-} from './pathSerializer.gen';
-
-export interface PathSerializer {
-  path: Record<string, unknown>;
-  url: string;
-}
-
-export const PATH_PARAM_RE = /\{[^{}]+\}/g;
-
-export const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => {
-  let url = _url;
-  const matches = _url.match(PATH_PARAM_RE);
-  if (matches) {
-    for (const match of matches) {
-      let explode = false;
-      let name = match.substring(1, match.length - 1);
-      let style: ArraySeparatorStyle = 'simple';
-
-      if (name.endsWith('*')) {
-        explode = true;
-        name = name.substring(0, name.length - 1);
-      }
-
-      if (name.startsWith('.')) {
-        name = name.substring(1);
-        style = 'label';
-      } else if (name.startsWith(';')) {
-        name = name.substring(1);
-        style = 'matrix';
-      }
-
-      const value = path[name];
-
-      if (value === undefined || value === null) {
-        continue;
-      }
-
-      if (Array.isArray(value)) {
-        url = url.replace(match, serializeArrayParam({ explode, name, style, value }));
-        continue;
-      }
-
-      if (typeof value === 'object') {
-        url = url.replace(
-          match,
-          serializeObjectParam({
-            explode,
-            name,
-            style,
-            value: value as Record<string, unknown>,
-            valueOnly: true,
-          }),
-        );
-        continue;
-      }
-
-      if (style === 'matrix') {
-        url = url.replace(
-          match,
-          `;${serializePrimitiveParam({
-            name,
-            value: value as string,
-          })}`,
-        );
-        continue;
-      }
-
-      const replaceValue = encodeURIComponent(
-        style === 'label' ? `.${value as string}` : (value as string),
-      );
-      url = url.replace(match, replaceValue);
-    }
-  }
-  return url;
-};
-
-export const getUrl = ({
-  baseUrl,
-  path,
-  query,
-  querySerializer,
-  url: _url,
-}: {
-  baseUrl?: string;
-  path?: Record<string, unknown>;
-  query?: Record<string, unknown>;
-  querySerializer: QuerySerializer;
-  url: string;
-}) => {
-  const pathUrl = _url.startsWith('/') ? _url : `/${_url}`;
-  let url = (baseUrl ?? '') + pathUrl;
-  if (path) {
-    url = defaultPathSerializer({ path, url });
-  }
-  let search = query ? querySerializer(query) : '';
-  if (search.startsWith('?')) {
-    search = search.substring(1);
-  }
-  if (search) {
-    url += `?${search}`;
-  }
-  return url;
-};
-
-export function getValidRequestBody(options: {
-  body?: unknown;
-  bodySerializer?: BodySerializer | null;
-  serializedBody?: unknown;
-}) {
-  const hasBody = options.body !== undefined;
-  const isSerializedBody = hasBody && options.bodySerializer;
-
-  if (isSerializedBody) {
-    if ('serializedBody' in options) {
-      const hasSerializedBody =
-        options.serializedBody !== undefined && options.serializedBody !== '';
-
-      return hasSerializedBody ? options.serializedBody : null;
-    }
-
-    // not all clients implement a serializedBody property (i.e., client-axios)
-    return options.body !== '' ? options.body : null;
-  }
-
-  // plain/text body
-  if (hasBody) {
-    return options.body;
-  }
-
-  // no body was provided
-  return undefined;
-}

package/src/_api/generated/cfg_centrifugo/sdk.gen.ts

@@ -1,64 +0,0 @@
-// This file is auto-generated by @hey-api/openapi-ts
-
-import type { Client, Options as Options2, TDataShape } from './client';
-import { client } from './client.gen';
-import type { CfgCentrifugoAuthTokenRetrieveData, CfgCentrifugoAuthTokenRetrieveErrors, CfgCentrifugoAuthTokenRetrieveResponses } from './types.gen';
-
-export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
-    /**
-     * You can provide a client instance returned by `createClient()` instead of
-     * individual options. This might be also useful if you want to implement a
-     * custom client.
-     */
-    client?: Client;
-    /**
-     * You can pass arbitrary values through the `meta` object. This can be
-     * used to access values that aren't defined as part of the SDK function.
-     */
-    meta?: Record<string, unknown>;
-};
-
-export class Cfg {
-    /**
-     * Get Centrifugo connection token
-     *
-     * Generate JWT token for WebSocket connection to Centrifugo. Token includes user's allowed channels based on their permissions. Requires authentication.
-     */
-    public static cfgCentrifugoAuthTokenRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgCentrifugoAuthTokenRetrieveData, ThrowOnError>) {
-        return (options?.client ?? client).get<CfgCentrifugoAuthTokenRetrieveResponses, CfgCentrifugoAuthTokenRetrieveErrors, ThrowOnError>({
-            security: [{ scheme: 'bearer', type: 'http' }],
-            url: '/cfg/centrifugo/auth/token/',
-            ...options
-        });
-    }
-}
-
-export class Centrifugo {
-    /**
-     * Get Centrifugo connection token
-     *
-     * Generate JWT token for WebSocket connection to Centrifugo. Token includes user's allowed channels based on their permissions. Requires authentication.
-     */
-    public static cfgCentrifugoAuthTokenRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgCentrifugoAuthTokenRetrieveData, ThrowOnError>) {
-        return (options?.client ?? client).get<CfgCentrifugoAuthTokenRetrieveResponses, CfgCentrifugoAuthTokenRetrieveErrors, ThrowOnError>({
-            security: [{ scheme: 'bearer', type: 'http' }],
-            url: '/cfg/centrifugo/auth/token/',
-            ...options
-        });
-    }
-}
-
-export class CentrifugoAuth {
-    /**
-     * Get Centrifugo connection token
-     *
-     * Generate JWT token for WebSocket connection to Centrifugo. Token includes user's allowed channels based on their permissions. Requires authentication.
-     */
-    public static cfgCentrifugoAuthTokenRetrieve<ThrowOnError extends boolean = false>(options?: Options<CfgCentrifugoAuthTokenRetrieveData, ThrowOnError>) {
-        return (options?.client ?? client).get<CfgCentrifugoAuthTokenRetrieveResponses, CfgCentrifugoAuthTokenRetrieveErrors, ThrowOnError>({
-            security: [{ scheme: 'bearer', type: 'http' }],
-            url: '/cfg/centrifugo/auth/token/',
-            ...options
-        });
-    }
-}

package/src/_api/generated/cfg_centrifugo/types.gen.ts

@@ -1,61 +0,0 @@
-// This file is auto-generated by @hey-api/openapi-ts
-
-export type ClientOptions = {
-    baseUrl: 'http://localhost:8000' | (string & {});
-};
-
-/**
- * ConnectionTokenResponse
- *
- * Response model for Centrifugo connection token.
- */
-export type ConnectionTokenResponse = {
-    /**
-     * Token
-     *
-     * JWT token for Centrifugo connection
-     */
-    token: string;
-    /**
-     * Centrifugo Url
-     *
-     * Centrifugo WebSocket URL
-     */
-    centrifugo_url: string;
-    /**
-     * Expires At
-     *
-     * Token expiration time (ISO 8601)
-     */
-    expires_at: string;
-    /**
-     * Channels
-     *
-     * List of allowed channels
-     */
-    channels: Array<string>;
-};
-
-export type CfgCentrifugoAuthTokenRetrieveData = {
-    body?: never;
-    path?: never;
-    query?: never;
-    url: '/cfg/centrifugo/auth/token/';
-};
-
-export type CfgCentrifugoAuthTokenRetrieveErrors = {
-    /**
-     * Unauthorized - authentication required
-     */
-    401: unknown;
-    /**
-     * Server error
-     */
-    500: unknown;
-};
-
-export type CfgCentrifugoAuthTokenRetrieveResponses = {
-    200: ConnectionTokenResponse;
-};
-
-export type CfgCentrifugoAuthTokenRetrieveResponse = CfgCentrifugoAuthTokenRetrieveResponses[keyof CfgCentrifugoAuthTokenRetrieveResponses];

package/src/_api/generated/cfg_totp/client/client.gen.ts

@@ -1,280 +0,0 @@
-// This file is auto-generated by @hey-api/openapi-ts
-
-import { createSseClient } from '../core/serverSentEvents.gen';
-import type { HttpMethod } from '../core/types.gen';
-import { getValidRequestBody } from '../core/utils.gen';
-import type { Client, Config, RequestOptions, ResolvedRequestOptions } from './types.gen';
-import {
-  buildUrl,
-  createConfig,
-  createInterceptors,
-  getParseAs,
-  mergeConfigs,
-  mergeHeaders,
-  setAuthParams,
-} from './utils.gen';
-
-type ReqInit = Omit<RequestInit, 'body' | 'headers'> & {
-  body?: any;
-  headers: ReturnType<typeof mergeHeaders>;
-};
-
-export const createClient = (config: Config = {}): Client => {
-  let _config = mergeConfigs(createConfig(), config);
-
-  const getConfig = (): Config => ({ ..._config });
-
-  const setConfig = (config: Config): Config => {
-    _config = mergeConfigs(_config, config);
-    return getConfig();
-  };
-
-  const interceptors = createInterceptors<Request, Response, unknown, ResolvedRequestOptions>();
-
-  const beforeRequest = async <
-    TData = unknown,
-    TResponseStyle extends 'data' | 'fields' = 'fields',
-    ThrowOnError extends boolean = boolean,
-    Url extends string = string,
-  >(
-    options: RequestOptions<TData, TResponseStyle, ThrowOnError, Url>,
-  ) => {
-    const opts = {
-      ..._config,
-      ...options,
-      fetch: options.fetch ?? _config.fetch ?? globalThis.fetch,
-      headers: mergeHeaders(_config.headers, options.headers),
-      serializedBody: undefined as string | 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) as string | undefined;
-    }
-
-    // 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 as typeof opts &
-      ResolvedRequestOptions<TResponseStyle, ThrowOnError, Url>;
-    const url = buildUrl(resolvedOpts);
-
-    return { opts: resolvedOpts, url };
-  };
-
-  const request: Client['request'] = async (options) => {
-    const throwOnError = options.throwOnError ?? _config.throwOnError;
-    const responseStyle = options.responseStyle ?? _config.responseStyle;
-
-    let request: Request | undefined;
-    let response: Response | undefined;
-
-    try {
-      const { opts, url } = await beforeRequest(options);
-      const requestInit: ReqInit = {
-        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: any;
-          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: any;
-        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: unknown;
-
-      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 as ResolvedRequestOptions);
-        }
-      }
-
-      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: Uppercase<HttpMethod>) => (options: RequestOptions) =>
-    request({ ...options, method });
-
-  const makeSseFn = (method: Uppercase<HttpMethod>) => async (options: RequestOptions) => {
-    const { opts, url } = await beforeRequest(options);
-    return createSseClient({
-      ...opts,
-      body: opts.body as BodyInit | null | undefined,
-      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) as BodyInit | null | undefined,
-      url,
-    });
-  };
-
-  const _buildUrl: Client['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'),
-  } as Client;
-};

package/src/_api/generated/cfg_totp/client/index.ts

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