django-cfg 1.4.107__py3-none-any.whl → 1.4.109__py3-none-any.whl

django_cfg/modules/django_client/system/schema_parser.py

@@ -1,199 +0,0 @@
-"""
-OpenAPI schema parser for extracting operation and type information.
-"""
-
-import re
-from typing import Any, Dict, List, Optional
-
-
-class SchemaParser:
-    """Parse OpenAPI schema to extract operation and type information."""
-
-    def __init__(self, schema: Dict[str, Any]):
-        """Initialize with OpenAPI schema."""
-        self.schema = schema
-        self.components = schema.get('components', {})
-        self.schemas = self.components.get('schemas', {})
-
-    def extract_app_from_path(self, path: str) -> str:
-        """Extract app name from API path."""
-        # Pattern: /cfg/{app_name}/...
-        match = re.match(r'/cfg/([^/]+)/', path)
-        if match:
-            return match.group(1)
-        return 'core'  # Default for paths without clear app
-
-    def extract_method_name(self, operation_id: str) -> str:
-        """Extract clean method name from operation ID."""
-        # Remove common prefixes
-        for prefix in ['cfg__', 'api_', 'cfg_']:
-            if operation_id.startswith(prefix):
-                operation_id = operation_id[len(prefix):]
-
-        # Handle double underscores
-        operation_id = operation_id.replace('__', '_')
-
-        return operation_id
-
-    def group_operations_by_app(self) -> Dict[str, List[Dict]]:
-        """Group API operations by Django app based on path patterns."""
-        grouped = {}
-
-        for path, path_item in self.schema.get('paths', {}).items():
-            for method, operation in path_item.items():
-                if method in ['get', 'post', 'put', 'patch', 'delete']:
-                    # Extract app name from path
-                    app_name = self.extract_app_from_path(path)
-
-                    # Add operation info
-                    op_info = {
-                        'path': path,
-                        'method': method,
-                        'operationId': operation.get('operationId', ''),
-                        'summary': operation.get('summary', ''),
-                        'description': operation.get('description', ''),
-                        'parameters': operation.get('parameters', []),
-                        'requestBody': operation.get('requestBody'),
-                        'responses': operation.get('responses', {}),
-                        'tags': operation.get('tags', [])
-                    }
-
-                    if app_name not in grouped:
-                        grouped[app_name] = []
-                    grouped[app_name].append(op_info)
-
-        return grouped
-
-    def extract_parameter_info(self, parameter: Dict[str, Any]) -> Dict[str, Any]:
-        """Extract detailed parameter information."""
-        param_info = {
-            'name': parameter.get('name'),
-            'in': parameter.get('in'),
-            'required': parameter.get('required', False),
-            'description': parameter.get('description', ''),
-            'schema': parameter.get('schema', {})
-        }
-
-        # Extract type information
-        schema = parameter.get('schema', {})
-        param_info['type'] = self.get_js_type(schema)
-        param_info['format'] = schema.get('format')
-
-        return param_info
-
-    def extract_request_body_info(self, request_body: Dict[str, Any]) -> Optional[Dict[str, Any]]:
-        """Extract request body information."""
-        if not request_body:
-            return None
-
-        content = request_body.get('content', {})
-        json_content = content.get('application/json', {})
-        schema = json_content.get('schema', {})
-
-        return {
-            'required': request_body.get('required', False),
-            'description': request_body.get('description', ''),
-            'schema': schema,
-            'type': self.get_js_type(schema)
-        }
-
-    def get_js_type(self, schema: Dict[str, Any]) -> str:
-        """Convert OpenAPI schema to JavaScript/TypeScript type."""
-        if not schema:
-            return 'any'
-
-        # Handle references
-        if '$ref' in schema:
-            ref_name = schema['$ref'].split('/')[-1]
-            return ref_name
-
-        # Handle arrays
-        if schema.get('type') == 'array':
-            items_type = self.get_js_type(schema.get('items', {}))
-            return f'{items_type}[]'
-
-        # Handle objects
-        if schema.get('type') == 'object':
-            # Check if it has specific properties
-            if 'properties' in schema:
-                # Could generate an interface here
-                return 'Object'
-            # Check for additionalProperties (dictionary-like)
-            if 'additionalProperties' in schema:
-                additional = schema['additionalProperties']
-                # additionalProperties can be bool or schema object
-                if isinstance(additional, bool):
-                    return 'Record<string, any>' if additional else 'Object'
-                value_type = self.get_js_type(additional)
-                return f'Record<string, {value_type}>'
-            return 'Object'
-
-        # Handle enums
-        if 'enum' in schema:
-            # Create a union type from enum values
-            values = schema['enum']
-            if all(isinstance(v, str) for v in values):
-                return ' | '.join(f'"{v}"' for v in values)
-            return 'string'
-
-        # Handle primitive types
-        type_mapping = {
-            'string': 'string',
-            'integer': 'number',
-            'number': 'number',
-            'boolean': 'boolean',
-            'null': 'null'
-        }
-
-        openapi_type = schema.get('type', 'any')
-
-        # Handle special formats
-        format_type = schema.get('format')
-        if openapi_type == 'string' and format_type:
-            format_mapping = {
-                'date': 'string',  # Could be Date
-                'date-time': 'string',  # Could be Date
-                'uuid': 'string',
-                'email': 'string',
-                'uri': 'string',
-                'binary': 'Blob',
-                'byte': 'string'
-            }
-            return format_mapping.get(format_type, 'string')
-
-        return type_mapping.get(openapi_type, 'any')
-
-    def get_response_type(self, responses: Dict[str, Any]) -> str:
-        """Extract the response type from operation responses."""
-        # Look for successful response (200, 201, etc.)
-        for status in ['200', '201', '202']:
-            if status in responses:
-                response = responses[status]
-                content = response.get('content', {})
-
-                if 'application/json' in content:
-                    schema = content['application/json'].get('schema', {})
-                    return self.get_js_type(schema)
-
-        # Check for 204 No Content
-        if '204' in responses:
-            return 'void'
-
-        # Default to any
-        return 'any'
-
-    def resolve_ref(self, ref: str) -> Optional[Dict[str, Any]]:
-        """Resolve a $ref to its schema definition."""
-        if not ref.startswith('#/'):
-            return None
-
-        parts = ref[2:].split('/')
-        current = self.schema
-
-        for part in parts:
-            if isinstance(current, dict) and part in current:
-                current = current[part]
-            else:
-                return None
-
-        return current

django_cfg/modules/django_client/system/templates/api_client.js.j2

@@ -1,87 +0,0 @@
-import { BaseAPIClient } from '../base.mjs';
-
-/**
- * {{ app_name.replace('_', ' ').title() }} API Client
- * Auto-generated from OpenAPI schema
- * @module {{ app_name }}
- * @extends BaseAPIClient
- */
-export class {{ class_name }} extends BaseAPIClient {
-    /**
-     * Initialize {{ app_name }} API client
-     * @param {string} [baseURL] - Optional base URL
-     */
-    constructor(baseURL) {
-        super(baseURL);
-    }
-
-{% for method in methods %}
-    /**
-     * {{ method.summary or method.name }}
-{%- if method.description %}
-     * {{ method.description }}
-{%- endif %}
-{%- for param in method.path_params %}
-     * @param {{ '{' }}{{ param.type }}{{ '}' }} {{ param.name }}{% if param.description %} - {{ param.description }}{% endif %}
-{%- endfor %}
-{%- if method.request_body %}
-     * @param {{ '{' }}{{ method.request_body.type }}{{ '}' }} data - Request body{% if method.request_body.description %} - {{ method.request_body.description }}{% endif %}
-{%- endif %}
-{%- if method.query_params %}
-     * @param {{ '{Object}' }} [params={}] - Query parameters
-{%- for param in method.query_params %}
-     * @param {{ '{' }}{{ param.type }}{{ '}' }} [params.{{ param.name }}]{% if param.description %} - {{ param.description }}{% endif %}
-{%- endfor %}
-{%- endif %}
-     * @returns {{ '{Promise<' }}{{ method.response_type }}{{ '>}' }} {{ 'Response data' if method.response_type != 'void' else 'No content' }}
-     */
-    async {{ method.name }}(
-{%- set params = [] %}
-{%- for param in method.path_params %}
-    {%- set _ = params.append(param.name) %}
-{%- endfor %}
-{%- if method.request_body %}
-    {%- set _ = params.append('data') %}
-{%- endif %}
-{%- if method.query_params %}
-    {%- set _ = params.append('params = {}') %}
-{%- endif %}
-{{- params | join(', ') -}}
-) {
-        const path = `{{ method.path }}`;
-{%- if method.http_method == 'GET' %}
-    {%- if method.query_params %}
-        return this.get(path, params);
-    {%- else %}
-        return this.get(path);
-    {%- endif %}
-{%- elif method.http_method == 'POST' %}
-    {%- if method.request_body %}
-        return this.post(path, data);
-    {%- else %}
-        return this.post(path, {});
-    {%- endif %}
-{%- elif method.http_method == 'PUT' %}
-    {%- if method.request_body %}
-        return this.put(path, data);
-    {%- else %}
-        return this.put(path, {});
-    {%- endif %}
-{%- elif method.http_method == 'PATCH' %}
-    {%- if method.request_body %}
-        return this.patch(path, data);
-    {%- else %}
-        return this.patch(path, {});
-    {%- endif %}
-{%- elif method.http_method == 'DELETE' %}
-        return this.delete(path);
-{%- endif %}
-    }
-{% endfor %}
-}
-
-// Default instance for convenience
-export const {{ instance_name }} = new {{ class_name }}();
-
-// Default export
-export default {{ class_name }};

django_cfg/modules/django_client/system/templates/app_index.js.j2

@@ -1,13 +0,0 @@
-/**
- * {{ app_name.replace('_', ' ').title() }} API Module
- * Re-exports the API client for convenient importing
- * @module {{ app_name }}
- */
-
-import { {{ class_name }}, {{ instance_name }} } from './client.mjs';
-
-// Re-export the class and instance
-export { {{ class_name }}, {{ instance_name }} };
-
-// Default export is the instance for convenience
-export default {{ instance_name }};

django_cfg/modules/django_client/system/templates/base_client.js.j2

@@ -1,166 +0,0 @@
-/**
- * Base API Client for django-cfg
- * Lightweight ES Module with JSDoc type annotations
- * @module base
- */
-
-/**
- * Custom error class for API errors
- * @class APIError
- * @extends Error
- */
-class APIError extends Error {
-    /**
-     * @param {string} message - Error message
-     * @param {number} status - HTTP status code
-     * @param {any} data - Additional error data
-     */
-    constructor(message, status, data) {
-        super(message);
-        this.name = 'APIError';
-        this.status = status;
-        this.data = data;
-    }
-}
-
-/**
- * Get Django CSRF token from cookies
- * @returns {string} CSRF token value
- */
-function getCsrfToken() {
-    const cookie = document.cookie.split('; ')
-        .find(row => row.startsWith('csrftoken='));
-    return cookie ? cookie.split('=')[1] : '';
-}
-
-/**
- * @typedef {Object} RequestOptions
- * @property {string} [method='GET'] - HTTP method
- * @property {Object} [headers={}] - Request headers
- * @property {any} [body] - Request body
- * @property {string} [credentials='same-origin'] - Credentials mode
- */
-
-/**
- * Base API client class with built-in Django CSRF support
- * @class BaseAPIClient
- */
-export class BaseAPIClient {
-    /**
-     * Initialize the API client
-     * @param {string} [baseURL=''] - Base URL for API requests (defaults to current origin)
-     */
-    constructor(baseURL = '') {
-        this.baseURL = baseURL || window.location.origin;
-    }
-
-    /**
-     * Make an API request
-     * @param {string} path - API endpoint path
-     * @param {RequestOptions} [options={}] - Request options
-     * @returns {Promise<any>} Response data
-     * @throws {APIError} When request fails
-     */
-    async request(path, options = {}) {
-        const url = `${this.baseURL}${path}`;
-
-        // Default headers with CSRF token
-        const headers = {
-            'Content-Type': 'application/json',
-            'X-CSRFToken': getCsrfToken(),
-            ...options.headers
-        };
-
-        try {
-            const response = await fetch(url, {
-                ...options,
-                headers,
-                credentials: 'same-origin'
-            });
-
-            if (!response.ok) {
-                const error = await response.json().catch(() => ({}));
-                throw new APIError(
-                    error.detail || `HTTP ${response.status}`,
-                    response.status,
-                    error
-                );
-            }
-
-            // Handle empty responses
-            if (response.status === 204) {
-                return null;
-            }
-
-            return await response.json();
-        } catch (error) {
-            if (error instanceof APIError) {
-                throw error;
-            }
-            throw new APIError(error.message, 0, null);
-        }
-    }
-
-    /**
-     * Make a GET request
-     * @param {string} path - API endpoint path
-     * @param {Object} [params={}] - Query parameters
-     * @returns {Promise<any>} Response data
-     */
-    async get(path, params = {}) {
-        const queryString = new URLSearchParams(params).toString();
-        const fullPath = queryString ? `${path}?${queryString}` : path;
-        return this.request(fullPath, { method: 'GET' });
-    }
-
-    /**
-     * Make a POST request
-     * @param {string} path - API endpoint path
-     * @param {any} [data={}] - Request body data
-     * @returns {Promise<any>} Response data
-     */
-    async post(path, data = {}) {
-        return this.request(path, {
-            method: 'POST',
-            body: JSON.stringify(data)
-        });
-    }
-
-    /**
-     * Make a PUT request
-     * @param {string} path - API endpoint path
-     * @param {any} [data={}] - Request body data
-     * @returns {Promise<any>} Response data
-     */
-    async put(path, data = {}) {
-        return this.request(path, {
-            method: 'PUT',
-            body: JSON.stringify(data)
-        });
-    }
-
-    /**
-     * Make a PATCH request
-     * @param {string} path - API endpoint path
-     * @param {any} [data={}] - Request body data
-     * @returns {Promise<any>} Response data
-     */
-    async patch(path, data = {}) {
-        return this.request(path, {
-            method: 'PATCH',
-            body: JSON.stringify(data)
-        });
-    }
-
-    /**
-     * Make a DELETE request
-     * @param {string} path - API endpoint path
-     * @returns {Promise<any>} Response data
-     */
-    async delete(path) {
-        return this.request(path, { method: 'DELETE' });
-    }
-}
-
-// Export the error class as well
-export { APIError };

django_cfg/modules/django_client/system/templates/main_index.js.j2

@@ -1,80 +0,0 @@
-/**
- * Django CFG API Clients
- * Lightweight ES Modules with JSDoc type annotations
- * Organized by Django apps
- *
- * @module django-cfg-api
- *
- * @example
- * // Import specific app API
- * import { tasksAPI } from '/static/api/tasks/index.mjs';
- * const stats = await tasksAPI.cfgTasksApiTasksStatsRetrieve();
- *
- * @example
- * // Import multiple APIs from main index
- * import { tasksAPI, paymentsAPI } from '/static/api/index.mjs';
- *
- * @example
- * // Import with custom base URL
- * import { TasksAPI } from '/static/api/tasks/index.mjs';
- * const api = new TasksAPI('https://api.example.com');
- */
-
-import { BaseAPIClient } from './base.mjs';
-{% for app in apps %}
-import { {{ app.class_name }}, {{ app.instance_name }} } from './{{ app.app_name }}/index.mjs';
-{% endfor %}
-
-/**
- * Export all API classes for custom instantiation
- * @exports
- */
-export {
-    BaseAPIClient,
-{% for app in apps %}
-    {{ app.class_name }},
-{% endfor %}
-};
-
-/**
- * Export all default instances for convenience
- * These instances use the current origin as base URL
- * @exports
- */
-export {
-{% for app in apps %}
-    {{ app.instance_name }},
-{% endfor %}
-};
-
-/**
- * Grouped exports by functionality
- * Access APIs by app name: apis.tasks, apis.payments, etc.
- * @type {Object.<string, BaseAPIClient>}
- */
-export const apis = {
-{% for app in apps %}
-    {{ app.app_name }}: {{ app.instance_name }},
-{% endfor %}
-};
-
-/**
- * Helper function to get API by app name
- * @param {string} appName - Name of the Django app
- * @returns {BaseAPIClient|undefined} API instance for the app
- * @example
- * const tasksAPI = getAPI('tasks');
- */
-export function getAPI(appName) {
-    return apis[appName];
-}
-
-/**
- * List of all available apps
- * @type {string[]}
- */
-export const availableApps = [
-{% for app in apps %}
-    '{{ app.app_name }}',
-{% endfor %}
-];

django_cfg/modules/django_client/system/templates/types.js.j2

@@ -1,24 +0,0 @@
-/**
- * Type definitions for django-cfg API
- * Auto-generated from OpenAPI schema
- * @module types
- */
-
-// This file contains JSDoc type definitions generated from the OpenAPI schema
-// These types can be used for better IDE support and documentation
-
-{% for typedef in typedefs %}
-/**
- * @typedef {{ '{Object}' }} {{ typedef.name }}
-{%- if typedef.description %}
- * @description {{ typedef.description }}
-{%- endif %}
-{%- for prop in typedef.properties %}
- * @property {{ '{' }}{{ prop.type }}{{ '}' }} {% if not prop.required %}[{% endif %}{{ prop.name }}{% if not prop.required %}]{% endif %}{% if prop.description %} - {{ prop.description }}{% endif %}
-{%- endfor %}
- */
-
-{% endfor %}
-
-// Export empty object to make this a module
-export {};

django_cfg/modules/django_tasks/__init__.py

@@ -1,29 +0,0 @@
-"""
-Django-CFG Task Service Module.
-
-Simplified task service for Dramatiq integration with essential functionality.
-"""
-
-from .factory import (
-    get_task_health,
-    get_task_service,
-    initialize_task_system,
-    is_task_system_available,
-    reset_task_service,
-)
-from .service import DjangoTasks
-from .settings import (
-    extend_constance_config_with_tasks,
-    generate_dramatiq_settings_from_config,
-)
-
-__all__ = [
-    "DjangoTasks",
-    "get_task_service",
-    "reset_task_service",
-    "is_task_system_available",
-    "get_task_health",
-    "generate_dramatiq_settings_from_config",
-    "extend_constance_config_with_tasks",
-    "initialize_task_system",
-]

django_cfg/modules/django_tasks/dramatiq_setup.py

@@ -1,20 +0,0 @@
-"""
-Dramatiq broker module for django-cfg CLI integration.
-
-This module provides the broker instance required by Dramatiq CLI.
-It's a thin wrapper around django_dramatiq.setup with broker export.
-
-Usage:
-    dramatiq django_cfg.modules.dramatiq_setup [task_modules...]
-"""
-
-# CRITICAL: Initialize Django BEFORE any model imports in worker processes
-import django
-
-# Initialize Django app registry (DJANGO_SETTINGS_MODULE must be set by caller)
-django.setup()
-
-# Re-export the broker for Dramatiq CLI
-import dramatiq
-
-broker = dramatiq.get_broker()