@djangocfg/ext-knowbase 1.0.9 → 1.0.10

package/src/api/generated/ext_knowbase/_utils/schemas/CfgKnowbaseSystemArchivesCreateRequest.schema.ts

@@ -0,0 +1,20 @@
+/**
+ * Zod schema for CfgKnowbaseSystemArchivesCreateRequest
+ *
+ * This schema provides runtime validation and type inference.
+ *  */
+import { z } from 'zod'
+
+export const CfgKnowbaseSystemArchivesCreateRequestSchema = z.object({
+  file: z.union([z.instanceof(File), z.instanceof(Blob)]).optional(),
+  title: z.string().optional(),
+  description: z.string().optional(),
+  category_ids: z.array(z.string()).optional(),
+  is_public: z.boolean().optional(),
+  process_immediately: z.boolean().optional(),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type CfgKnowbaseSystemArchivesCreateRequest = z.infer<typeof CfgKnowbaseSystemArchivesCreateRequestSchema>

package/src/api/generated/ext_knowbase/_utils/schemas/DocumentArchive.schema.ts

@@ -17,7 +17,7 @@ export const DocumentArchiveSchema = z.object({
   description: z.string().optional(),
   categories: z.array(DocumentCategorySchema),
   is_public: z.boolean().optional(),
-  archive_file: z.url(),
+  archive_file: z.union([z.url(), z.literal('')]),
   original_filename: z.string(),
   file_size: z.int(),
   archive_type: z.nativeEnum(Enums.DocumentArchiveArchiveType),

package/src/api/generated/ext_knowbase/_utils/schemas/DocumentArchiveDetail.schema.ts

@@ -18,7 +18,7 @@ export const DocumentArchiveDetailSchema = z.object({
   description: z.string().optional(),
   categories: z.array(DocumentCategorySchema),
   is_public: z.boolean().optional(),
-  archive_file: z.url(),
+  archive_file: z.union([z.url(), z.literal('')]),
   original_filename: z.string(),
   file_size: z.int(),
   archive_type: z.nativeEnum(Enums.DocumentArchiveDetailArchiveType),

package/src/api/generated/ext_knowbase/_utils/schemas/index.ts

@@ -27,6 +27,7 @@ export * from './ArchiveProcessingResult.schema'
 export * from './ArchiveSearchRequestRequest.schema'
 export * from './ArchiveSearchResult.schema'
 export * from './ArchiveStatistics.schema'
+export * from './CfgKnowbaseSystemArchivesCreateRequest.schema'
 export * from './ChatHistory.schema'
 export * from './ChatMessage.schema'
 export * from './ChatQueryRequest.schema'

package/src/api/generated/ext_knowbase/api-instance.ts

@@ -1,29 +1,37 @@
 // Auto-generated by DjangoCFG - see CLAUDE.md
 /**
- * Global API Instance - Singleton configuration
+ * Global API Instance - Singleton configuration with auto-configuration support
  *
- * This module provides a global API instance that can be configured once
- * and used throughout your application.
+ * This module provides a global API instance that auto-configures from
+ * environment variables or can be configured manually.
  *
- * Usage:
+ * AUTO-CONFIGURATION (recommended):
+ * Set one of these environment variables and the API will auto-configure:
+ * - NEXT_PUBLIC_API_URL (Next.js)
+ * - VITE_API_URL (Vite)
+ * - REACT_APP_API_URL (Create React App)
+ * - API_URL (generic)
+ *
+ * Then just use fetchers and hooks directly:
+ * ```typescript
+ * import { getUsers } from './_utils/fetchers'
+ * const users = await getUsers({ page: 1 })
+ * ```
+ *
+ * MANUAL CONFIGURATION:
  * ```typescript
- * // Configure once (e.g., in your app entry point)
  * import { configureAPI } from './api-instance'
  *
  * configureAPI({
  *   baseUrl: 'https://api.example.com',
  *   token: 'your-jwt-token'
  * })
- *
- * // Then use fetchers and hooks anywhere without configuration
- * import { getUsers } from './fetchers'
- * const users = await getUsers({ page: 1 })
  * ```
  *
  * For SSR or multiple instances:
  * ```typescript
  * import { API } from './index'
- * import { getUsers } from './fetchers'
+ * import { getUsers } from './_utils/fetchers'
  *
  * const api = new API('https://api.example.com')
  * const users = await getUsers({ page: 1 }, api)
@@ -33,27 +41,67 @@
 import { API, type APIOptions } from './index'
 
 let globalAPI: API | null = null
+let autoConfigAttempted = false
+
+/**
+ * Auto-configure from environment variable if available (Next.js pattern)
+ * This allows hooks and fetchers to work without explicit configureAPI() call
+ *
+ * Supported environment variables:
+ * - NEXT_PUBLIC_API_URL (Next.js)
+ * - VITE_API_URL (Vite)
+ * - REACT_APP_API_URL (Create React App)
+ * - API_URL (generic)
+ */
+function tryAutoConfigureFromEnv(): void {
+  // Only attempt once
+  if (autoConfigAttempted) return
+  autoConfigAttempted = true
+
+  // Skip if already configured
+  if (globalAPI) return
+
+  // Skip if process is not available (pure browser without bundler)
+  if (typeof process === 'undefined' || !process.env) return
+
+  // Try different environment variable patterns
+  const baseUrl =
+    process.env.NEXT_PUBLIC_API_URL ||
+    process.env.VITE_API_URL ||
+    process.env.REACT_APP_API_URL ||
+    process.env.API_URL
+
+  if (baseUrl) {
+    globalAPI = new API(baseUrl)
+  }
+}
 
 /**
  * Get the global API instance
- * @throws Error if API is not configured
+ * Auto-configures from environment variables on first call if not manually configured.
+ * @throws Error if API is not configured and no env variable is set
  */
 export function getAPIInstance(): API {
+  // Try auto-configuration on first access (lazy initialization)
+  tryAutoConfigureFromEnv()
+
   if (!globalAPI) {
     throw new Error(
       'API not configured. Call configureAPI() with your base URL before using fetchers or hooks.\n\n' +
       'Example:\n' +
       '  import { configureAPI } from "./api-instance"\n' +
-      '  configureAPI({ baseUrl: "https://api.example.com" })'
+      '  configureAPI({ baseUrl: "https://api.example.com" })\n\n' +
+      'Or set environment variable: NEXT_PUBLIC_API_URL, VITE_API_URL, or REACT_APP_API_URL'
     )
   }
   return globalAPI
 }
 
 /**
- * Check if API is configured
+ * Check if API is configured (or can be auto-configured)
  */
 export function isAPIConfigured(): boolean {
+  tryAutoConfigureFromEnv()
   return globalAPI !== null
 }
 

package/src/api/generated/ext_knowbase/client.ts

@@ -25,6 +25,7 @@ export class APIClient {
   private httpClient: HttpClientAdapter;
   private logger: APILogger | null = null;
   private retryConfig: RetryConfig | null = null;
+  private tokenGetter: (() => string | null) | null = null;
 
   // Sub-clients
   public ext_knowbase_knowbase: ExtKnowbaseKnowbase;
@@ -35,10 +36,12 @@ export class APIClient {
       httpClient?: HttpClientAdapter;
       loggerConfig?: Partial<LoggerConfig>;
       retryConfig?: RetryConfig;
+      tokenGetter?: () => string | null;
     }
   ) {
     this.baseUrl = baseUrl.replace(/\/$/, '');
     this.httpClient = options?.httpClient || new FetchAdapter();
+    this.tokenGetter = options?.tokenGetter || null;
 
     // Initialize logger if config provided
     if (options?.loggerConfig !== undefined) {
@@ -69,6 +72,21 @@ export class APIClient {
     return null;
   }
 
+  /**
+   * Get the base URL for building streaming/download URLs.
+   */
+  getBaseUrl(): string {
+    return this.baseUrl;
+  }
+
+  /**
+   * Get JWT token for URL authentication (used in streaming endpoints).
+   * Returns null if no token getter is configured or no token is available.
+   */
+  getToken(): string | null {
+    return this.tokenGetter ? this.tokenGetter() : null;
+  }
+
   /**
    * Make HTTP request with Django CSRF and session handling.
    * Automatically retries on network errors and 5xx server errors.
@@ -80,6 +98,7 @@ export class APIClient {
       params?: Record<string, any>;
       body?: any;
       formData?: FormData;
+      binaryBody?: Blob | ArrayBuffer;
       headers?: Record<string, string>;
     }
   ): Promise<T> {
@@ -116,6 +135,7 @@ export class APIClient {
       params?: Record<string, any>;
       body?: any;
       formData?: FormData;
+      binaryBody?: Blob | ArrayBuffer;
       headers?: Record<string, string>;
     }
   ): Promise<T> {
@@ -129,8 +149,8 @@ export class APIClient {
       ...(options?.headers || {})
     };
 
-    // Don't set Content-Type for FormData (browser will set it with boundary)
-    if (!options?.formData && !headers['Content-Type']) {
+    // Don't set Content-Type for FormData/binaryBody (browser will set it with boundary)
+    if (!options?.formData && !options?.binaryBody && !headers['Content-Type']) {
       headers['Content-Type'] = 'application/json';
     }
 
@@ -157,6 +177,7 @@ export class APIClient {
         params: options?.params,
         body: options?.body,
         formData: options?.formData,
+        binaryBody: options?.binaryBody,
       });
 
       const duration = Date.now() - startTime;

package/src/api/generated/ext_knowbase/ext_knowbase__knowbase/client.ts

@@ -356,8 +356,15 @@ export class ExtKnowbaseKnowbase {
    * 
    * Upload archive file and process it synchronously
    */
-  async systemArchivesCreate(data: FormData): Promise<Models.ArchiveProcessingResult> {
-    const response = await this.client.request('POST', "/cfg/knowbase/system/archives/", { formData: data });
+  async systemArchivesCreate(data: Models.CfgKnowbaseSystemArchivesCreateRequest): Promise<Models.ArchiveProcessingResult> {
+    const formData = new FormData();
+    formData.append('file', data.file);
+    if (data.title !== undefined) formData.append('title', String(data.title));
+    if (data.description !== undefined) formData.append('description', String(data.description));
+    if (data.category_ids !== undefined) formData.append('category_ids', String(data.category_ids));
+    if (data.is_public !== undefined) formData.append('is_public', String(data.is_public));
+    if (data.process_immediately !== undefined) formData.append('process_immediately', String(data.process_immediately));
+    const response = await this.client.request('POST', "/cfg/knowbase/system/archives/", { formData });
     return response;
   }
 

package/src/api/generated/ext_knowbase/ext_knowbase__knowbase/models.ts

@@ -434,6 +434,19 @@ export interface PaginatedDocumentArchiveListList {
   results: Array<DocumentArchiveList>;
 }
 
+/**
+ * 
+ * Request model (no read-only fields).
+ */
+export interface CfgKnowbaseSystemArchivesCreateRequest {
+  file?: File | Blob;
+  title?: string;
+  description?: string;
+  category_ids?: Array<string>;
+  is_public?: boolean;
+  process_immediately?: boolean;
+}
+
 /**
  * Archive processing result serializer.
  * 

package/src/api/generated/ext_knowbase/http.ts

@@ -14,6 +14,8 @@ export interface HttpRequest {
   params?: Record<string, any>;
   /** FormData for file uploads (multipart/form-data) */
   formData?: FormData;
+  /** Binary data for octet-stream uploads */
+  binaryBody?: Blob | ArrayBuffer;
 }
 
 export interface HttpResponse<T = any> {
@@ -37,7 +39,7 @@ export interface HttpClientAdapter {
  */
 export class FetchAdapter implements HttpClientAdapter {
   async request<T = any>(request: HttpRequest): Promise<HttpResponse<T>> {
-    const { method, url, headers, body, params, formData } = request;
+    const { method, url, headers, body, params, formData, binaryBody } = request;
 
     // Build URL with query params
     let finalUrl = url;
@@ -58,12 +60,16 @@ export class FetchAdapter implements HttpClientAdapter {
     const finalHeaders: Record<string, string> = { ...headers };
 
     // Determine body and content-type
-    let requestBody: string | FormData | undefined;
+    let requestBody: string | FormData | Blob | ArrayBuffer | undefined;
 
     if (formData) {
       // For multipart/form-data, let browser set Content-Type with boundary
       requestBody = formData;
       // Don't set Content-Type - browser will set it with boundary
+    } else if (binaryBody) {
+      // Binary upload (application/octet-stream)
+      finalHeaders['Content-Type'] = 'application/octet-stream';
+      requestBody = binaryBody;
     } else if (body) {
       // JSON request
       finalHeaders['Content-Type'] = 'application/json';

package/src/api/generated/ext_knowbase/index.ts

@@ -133,10 +133,11 @@ export class API {
 
     this._loadTokensFromStorage();
 
-    // Initialize APIClient
+    // Initialize APIClient with token getter for URL authentication
     this._client = new APIClient(this.baseUrl, {
       retryConfig: this.options?.retryConfig,
       loggerConfig: this.options?.loggerConfig,
+      tokenGetter: () => this.getToken(),
     });
 
     // Always inject auth header wrapper (reads token dynamically from storage)
@@ -155,6 +156,7 @@ export class API {
     this._client = new APIClient(this.baseUrl, {
       retryConfig: this.options?.retryConfig,
       loggerConfig: this.options?.loggerConfig,
+      tokenGetter: () => this.getToken(),
     });
 
     // Always inject auth header wrapper (reads token dynamically from storage)

package/src/api/index.ts

@@ -1,4 +1,4 @@
-import { createExtensionAPI } from '@djangocfg/ext-base/api';
+import { createExtensionAPI, initializeExtensionAPI } from '@djangocfg/ext-base/api';
 
 /**
  * Knowbase Extension API
@@ -6,7 +6,12 @@ import { createExtensionAPI } from '@djangocfg/ext-base/api';
  * Pre-configured API instance with shared authentication
  */
 import { API } from './generated/ext_knowbase';
+import { configureAPI } from './generated/ext_knowbase/api-instance';
 
+// Initialize global API singleton for hooks and fetchers
+initializeExtensionAPI(configureAPI);
+
+// Create instance for direct usage
 export const apiKnowbase = createExtensionAPI(API);
 
 // Export types, fetchers, and hooks

package/src/contexts/knowbase/DocumentsContext.tsx

@@ -31,6 +31,7 @@ import type {
   PaginatedDocumentArchiveListList,
   DocumentArchive,
   DocumentArchiveDetail,
+  ArchiveCreateRequest,
   PatchedDocumentArchiveRequest,
   ArchiveProcessingResult,
   ArchiveStatistics,
@@ -66,7 +67,7 @@ export interface KnowbaseDocumentsContextValue {
   // Archive operations
   getArchive: (id: string) => Promise<DocumentArchiveDetail | undefined>;
   getArchiveStatistics: () => Promise<ArchiveStatistics | undefined>;
-  createArchive: (data: FormData) => Promise<ArchiveProcessingResult>;
+  createArchive: (data: ArchiveCreateRequest) => Promise<ArchiveProcessingResult>;
   updateArchive: (
     id: string,
     title: string,
@@ -196,7 +197,7 @@ export function KnowbaseDocumentsProvider({ children }: { children: ReactNode })
   };
 
   // Create archive
-  const createArchive = async (data: FormData): Promise<ArchiveProcessingResult> => {
+  const createArchive = async (data: ArchiveCreateRequest): Promise<ArchiveProcessingResult> => {
     const result = await createArchiveMutation(data, apiKnowbase);
     await refreshArchives();
     return result as unknown as ArchiveProcessingResult;
@@ -293,6 +294,7 @@ export type {
   PaginatedDocumentArchiveListList,
   DocumentArchive,
   DocumentArchiveDetail,
+  ArchiveCreateRequest,
   PatchedDocumentArchiveRequest,
   ArchiveProcessingResult,
   ArchiveStatistics,

package/src/contexts/knowbase/types.ts

@@ -54,6 +54,7 @@ export type DocumentStats = NonNullable<Awaited<ReturnType<typeof useKnowbaseAdm
 export type PaginatedDocumentArchiveListList = NonNullable<Awaited<ReturnType<typeof useKnowbaseSystemArchivesList>>['data']>;
 export type DocumentArchive = NonNullable<Awaited<ReturnType<typeof useKnowbaseSystemArchivesRetrieve>>['data']>;
 export type DocumentArchiveDetail = NonNullable<Awaited<ReturnType<typeof useKnowbaseSystemArchivesRetrieve>>['data']>;
+export type ArchiveCreateRequest = Parameters<ReturnType<typeof useCreateKnowbaseSystemArchivesCreate>>[0];
 export type PatchedDocumentArchiveRequest = Parameters<ReturnType<typeof usePartialUpdateKnowbaseSystemArchivesPartialUpdate>>[1];
 export type ArchiveProcessingResult = Awaited<ReturnType<ReturnType<typeof useCreateKnowbaseSystemArchivesCreate>>>;
 export type ArchiveStatistics = NonNullable<Awaited<ReturnType<typeof useKnowbaseSystemArchivesStatisticsRetrieve>>['data']>;