@djangocfg/api 2.1.322 → 2.1.331

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

@@ -0,0 +1,140 @@
+// 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/helpers/errors.ts

@@ -0,0 +1,70 @@
+// AUTO-GENERATED by django_generator / ts_extras.wrapper
+// Typed error classes with DRF field-error support.
+// DO NOT EDIT — re-run `make gen`.
+
+/**
+ * HTTP API Error with DRF field-specific validation errors.
+ */
+export class APIError extends Error {
+  constructor(
+    public statusCode: number,
+    public statusText: string,
+    public response: any,
+    public url: string,
+    message?: string,
+  ) {
+    super(message || `HTTP ${statusCode}: ${statusText}`);
+    this.name = "APIError";
+  }
+
+  get details(): Record<string, any> | null {
+    if (typeof this.response === "object" && this.response !== null) {
+      return this.response;
+    }
+    return null;
+  }
+
+  get fieldErrors(): Record<string, string[]> | null {
+    const details = this.details;
+    if (!details) return null;
+    const fieldErrors: Record<string, string[]> = {};
+    for (const [key, value] of Object.entries(details)) {
+      if (Array.isArray(value)) fieldErrors[key] = value;
+    }
+    return Object.keys(fieldErrors).length > 0 ? fieldErrors : null;
+  }
+
+  get errorMessage(): string {
+    const details = this.details;
+    if (!details) return this.message;
+    if (details.detail) {
+      return Array.isArray(details.detail) ? details.detail.join(", ") : String(details.detail);
+    }
+    if (details.error) return String(details.error);
+    if (details.message) return String(details.message);
+    const fieldErrors = this.fieldErrors;
+    if (fieldErrors) {
+      const firstField = Object.keys(fieldErrors)[0];
+      if (firstField) return `${firstField}: ${fieldErrors[firstField]?.join(", ")}`;
+    }
+    return this.message;
+  }
+
+  get isValidationError(): boolean { return this.statusCode === 400; }
+  get isAuthError(): boolean { return this.statusCode === 401; }
+  get isPermissionError(): boolean { return this.statusCode === 403; }
+  get isNotFoundError(): boolean { return this.statusCode === 404; }
+  get isServerError(): boolean { return this.statusCode >= 500 && this.statusCode < 600; }
+}
+
+/** Network Error (connection failed, timeout, etc.) */
+export class NetworkError extends Error {
+  constructor(
+    message: string,
+    public url: string,
+    public originalError?: Error,
+  ) {
+    super(message);
+    this.name = "NetworkError";
+  }
+}

package/src/_api/generated/helpers/index.ts

@@ -0,0 +1,25 @@
+// AUTO-GENERATED by django_generator / ts_extras.wrapper
+// Shared utilities barrel. DO NOT EDIT — re-run `make gen`.
+
+export {
+  type StorageAdapter,
+  LocalStorageAdapter,
+  MemoryStorageAdapter,
+  CookieStorageAdapter,
+} from './storage';
+export { APIError, NetworkError } from './errors';
+export {
+  APILogger,
+  defaultLogger,
+  type LoggerConfig,
+  type RequestLog,
+  type ResponseLog,
+  type ErrorLog,
+} from './logger';
+export {
+  dispatchValidationError,
+  onValidationError,
+  formatZodError,
+  type ValidationErrorDetail,
+  type ValidationErrorEvent,
+} from './validation-events';

package/src/_api/generated/helpers/logger.ts

@@ -0,0 +1,123 @@
+// AUTO-GENERATED by django_generator / ts_extras.wrapper
+// API logger built on consola. Optional dependency — install if you enable logging:
+//   npm install consola
+// DO NOT EDIT — re-run `make gen`.
+
+import { type ConsolaInstance, createConsola } from "consola";
+
+export interface RequestLog {
+  method: string;
+  url: string;
+  headers?: Record<string, string>;
+  body?: any;
+  timestamp: number;
+}
+
+export interface ResponseLog {
+  status: number;
+  statusText: string;
+  data?: any;
+  duration: number;
+  timestamp: number;
+}
+
+export interface ErrorLog {
+  message: string;
+  statusCode?: number;
+  fieldErrors?: Record<string, string[]>;
+  duration: number;
+  timestamp: number;
+}
+
+export interface LoggerConfig {
+  enabled: boolean;
+  logRequests: boolean;
+  logResponses: boolean;
+  logErrors: boolean;
+  logBodies: boolean;
+  logHeaders: boolean;
+  consola?: ConsolaInstance;
+}
+
+const DEFAULT_CONFIG: LoggerConfig = {
+  enabled: typeof process !== "undefined" && process.env?.NODE_ENV !== "production",
+  logRequests: true,
+  logResponses: true,
+  logErrors: true,
+  logBodies: true,
+  logHeaders: false,
+};
+
+const SENSITIVE_HEADERS = [
+  "authorization",
+  "cookie",
+  "set-cookie",
+  "x-api-key",
+  "x-csrf-token",
+];
+
+export class APILogger {
+  private config: LoggerConfig;
+  private consola: ConsolaInstance;
+
+  constructor(config: Partial<LoggerConfig> = {}) {
+    this.config = { ...DEFAULT_CONFIG, ...config };
+    this.consola = config.consola || createConsola({
+      level: this.config.enabled ? 4 : 0,
+    });
+  }
+
+  enable(): void { this.config.enabled = true; }
+  disable(): void { this.config.enabled = false; }
+  setConfig(config: Partial<LoggerConfig>): void {
+    this.config = { ...this.config, ...config };
+  }
+
+  private filterHeaders(headers?: Record<string, string>): Record<string, string> {
+    if (!headers) return {};
+    const filtered: Record<string, string> = {};
+    Object.keys(headers).forEach((key) => {
+      filtered[key] = SENSITIVE_HEADERS.includes(key.toLowerCase()) ? "***" : (headers[key] || "");
+    });
+    return filtered;
+  }
+
+  logRequest(request: RequestLog): void {
+    if (!this.config.enabled || !this.config.logRequests) return;
+    const { method, url, headers, body } = request;
+    this.consola.start(`${method} ${url}`);
+    if (this.config.logHeaders && headers) this.consola.debug("Headers:", this.filterHeaders(headers));
+    if (this.config.logBodies && body) this.consola.debug("Body:", body);
+  }
+
+  logResponse(request: RequestLog, response: ResponseLog): void {
+    if (!this.config.enabled || !this.config.logResponses) return;
+    const { method, url } = request;
+    const { status, statusText, data, duration } = response;
+    this.consola.success(`${method} ${url} ${status} ${statusText} (${duration}ms)`);
+    if (this.config.logBodies && data) this.consola.debug("Response:", data);
+  }
+
+  logError(request: RequestLog, error: ErrorLog): void {
+    if (!this.config.enabled || !this.config.logErrors) return;
+    const { method, url } = request;
+    const { message, statusCode, fieldErrors, duration } = error;
+    this.consola.error(`${method} ${url} ${statusCode || "Network"} Error (${duration}ms)`);
+    this.consola.error("Message:", message);
+    if (fieldErrors && Object.keys(fieldErrors).length > 0) {
+      this.consola.error("Field Errors:");
+      Object.entries(fieldErrors).forEach(([field, errors]) => {
+        errors.forEach((err) => this.consola.error(`  • ${field}: ${err}`));
+      });
+    }
+  }
+
+  info(message: string, ...args: any[]): void { if (this.config.enabled) this.consola.info(message, ...args); }
+  warn(message: string, ...args: any[]): void { if (this.config.enabled) this.consola.warn(message, ...args); }
+  error(message: string, ...args: any[]): void { if (this.config.enabled) this.consola.error(message, ...args); }
+  debug(message: string, ...args: any[]): void { if (this.config.enabled) this.consola.debug(message, ...args); }
+  success(message: string, ...args: any[]): void { if (this.config.enabled) this.consola.success(message, ...args); }
+  withTag(tag: string): ConsolaInstance { return this.consola.withTag(tag); }
+}
+
+export const defaultLogger = new APILogger();

package/src/_api/generated/helpers/storage.ts

@@ -0,0 +1,83 @@
+// AUTO-GENERATED by django_generator / ts_extras.wrapper
+// Storage adapters for token persistence.
+// DO NOT EDIT — re-run `make gen`.
+
+export interface StorageAdapter {
+  getItem(key: string): string | null;
+  setItem(key: string, value: string): void;
+  removeItem(key: string): void;
+  clear?(): void;
+}
+
+/** Browser localStorage. Falls back to no-op on SSR / private mode. */
+export class LocalStorageAdapter implements StorageAdapter {
+  getItem(key: string): string | null {
+    if (typeof window === "undefined") return null;
+    try { return window.localStorage.getItem(key); } catch { return null; }
+  }
+  setItem(key: string, value: string): void {
+    if (typeof window === "undefined") return;
+    try { window.localStorage.setItem(key, value); } catch { /* quota / private */ }
+  }
+  removeItem(key: string): void {
+    if (typeof window === "undefined") return;
+    try { window.localStorage.removeItem(key); } catch { /* ignore */ }
+  }
+  clear(): void {
+    if (typeof window === "undefined") return;
+    try { window.localStorage.clear(); } catch { /* ignore */ }
+  }
+}
+
+/** In-memory store. Use for SSR, Electron main process, or tests. */
+export class MemoryStorageAdapter implements StorageAdapter {
+  private store = new Map<string, string>();
+  getItem(key: string): string | null { return this.store.get(key) ?? null; }
+  setItem(key: string, value: string): void { this.store.set(key, value); }
+  removeItem(key: string): void { this.store.delete(key); }
+  clear(): void { this.store.clear(); }
+}
+
+/** Cookie-backed storage (browser only). */
+export class CookieStorageAdapter implements StorageAdapter {
+  constructor(
+    private opts: {
+      domain?: string;
+      path?: string;
+      secure?: boolean;
+      sameSite?: "Strict" | "Lax" | "None";
+      maxAgeSeconds?: number;
+    } = {},
+  ) {}
+
+  getItem(key: string): string | null {
+    if (typeof document === "undefined") return null;
+    const prefix = `${encodeURIComponent(key)}=`;
+    for (const part of document.cookie.split("; ")) {
+      if (part.startsWith(prefix)) {
+        return decodeURIComponent(part.slice(prefix.length));
+      }
+    }
+    return null;
+  }
+
+  setItem(key: string, value: string): void {
+    if (typeof document === "undefined") return;
+    const parts = [
+      `${encodeURIComponent(key)}=${encodeURIComponent(value)}`,
+      `Path=${this.opts.path ?? "/"}`,
+    ];
+    if (this.opts.domain) parts.push(`Domain=${this.opts.domain}`);
+    if (this.opts.secure) parts.push("Secure");
+    if (this.opts.sameSite) parts.push(`SameSite=${this.opts.sameSite}`);
+    if (this.opts.maxAgeSeconds != null) {
+      parts.push(`Max-Age=${this.opts.maxAgeSeconds}`);
+    }
+    document.cookie = parts.join("; ");
+  }
+
+  removeItem(key: string): void {
+    if (typeof document === "undefined") return;
+    document.cookie = `${encodeURIComponent(key)}=; Max-Age=0; Path=${this.opts.path ?? "/"}`;
+  }
+}

package/src/_api/generated/helpers/validation-events.ts

@@ -0,0 +1,52 @@
+// AUTO-GENERATED by django_generator / ts_extras.wrapper
+// Browser CustomEvent integration for Zod validation errors.
+// DO NOT EDIT — re-run `make gen`.
+
+import type { ZodError } from "zod";
+
+export interface ValidationErrorDetail {
+  operation: string;
+  path: string;
+  method: string;
+  error: ZodError;
+  response: any;
+  timestamp: Date;
+}
+
+export type ValidationErrorEvent = CustomEvent<ValidationErrorDetail>;
+
+export function dispatchValidationError(detail: ValidationErrorDetail): void {
+  if (typeof window === "undefined") return;
+  try {
+    const event = new CustomEvent<ValidationErrorDetail>("zod-validation-error", {
+      detail,
+      bubbles: true,
+      cancelable: false,
+    });
+    window.dispatchEvent(event);
+  } catch (error) {
+    console.warn("Failed to dispatch validation error event:", error);
+  }
+}
+
+export function onValidationError(
+  callback: (detail: ValidationErrorDetail) => void,
+): () => void {
+  if (typeof window === "undefined") return () => {};
+  const handler = (event: Event) => {
+    if (event instanceof CustomEvent) callback(event.detail);
+  };
+  window.addEventListener("zod-validation-error", handler);
+  return () => window.removeEventListener("zod-validation-error", handler);
+}
+
+export function formatZodError(error: ZodError): string {
+  const issues = error.issues.map((issue, index) => {
+    const path = issue.path.join(".") || "root";
+    const parts = [`${index + 1}. ${path}: ${issue.message}`];
+    if ("expected" in issue && issue.expected) parts.push(`   Expected: ${issue.expected}`);
+    if ("received" in issue && issue.received) parts.push(`   Received: ${issue.received}`);
+    return parts.join("\n");
+  });
+  return issues.join("\n");
+}

package/src/_api/generated/index.ts

@@ -0,0 +1,28 @@
+// AUTO-GENERATED by django_generator / ts_extras.wrapper
+// Top-level barrel — one singleton API per group, baseUrl from Next.js env.
+// DO NOT EDIT — re-run `make gen`.
+
+import { API as CfgAccountsAPI, LocalStorageAdapter as CfgAccountsStorage } from './_cfg_accounts';
+import { API as CfgCentrifugoAPI, LocalStorageAdapter as CfgCentrifugoStorage } from './_cfg_centrifugo';
+import { API as CfgTotpAPI, LocalStorageAdapter as CfgTotpStorage } from './_cfg_totp';
+
+const isStaticBuild = process.env.NEXT_PUBLIC_STATIC_BUILD === 'true';
+const baseUrl = isStaticBuild ? '' : process.env.NEXT_PUBLIC_API_URL || '';
+
+export const CfgAccountsApi = new CfgAccountsAPI(baseUrl, { storage: new CfgAccountsStorage() });
+export const CfgCentrifugoApi = new CfgCentrifugoAPI(baseUrl, { storage: new CfgCentrifugoStorage() });
+export const CfgTotpApi = new CfgTotpAPI(baseUrl, { storage: new CfgTotpStorage() });
+
+// API wrapper classes — for users who need to construct their own
+// instance (e.g. with MemoryStorageAdapter in SSR/tests).
+export { API as CfgAccountsAPI } from './_cfg_accounts';
+export { API as CfgCentrifugoAPI } from './_cfg_centrifugo';
+export { API as CfgTotpAPI } from './_cfg_totp';
+
+// Hey API SDK classes — one per OpenAPI tag. Lets consumers call
+// `Centrifugo.cfgCentrifugoAuthTokenRetrieve({...})` directly without
+// going through the wrapper singleton.
+
+
+// Shared utilities (errors, storage adapters, logger).
+export * from './helpers';