create-odoo-module 1.0.0

package/src/generators/api-generator.js

@@ -0,0 +1,340 @@
+'use strict';
+
+const path = require('path');
+const { writeFile } = require('../utils/file-system');
+const logger = require('../utils/logger');
+
+/**
+ * Generate REST API controller for the Odoo module.
+ */
+async function generateApiLayer(targetDir, config) {
+  const odooDir = path.join(targetDir, 'odoo_module');
+  const s = config.moduleNameSnake;
+  const P = config.moduleNamePascal;
+  const M = config.moduleNameOdoo;
+  const L = config.moduleNameLabel;
+
+  logger.verbose('Generating REST API controller...');
+
+  await writeFile(
+    path.join(odooDir, 'controllers', `${s}_controller.py`),
+    genController(s, P, M, L, config)
+  );
+}
+
+// ─── Controller generator ────────────────────────────────────────────────────
+
+function genController(s, P, M, L, config) {
+  const endpoint = s.replace(/_/g, '-');
+
+  return `# -*- coding: utf-8 -*-
+"""
+REST API Controller for ${L} (${M}).
+Auto-generated by create-odoo-module — https://create-odoo-module.dev
+
+Endpoints:
+    GET    /api/${endpoint}            → List all records (with pagination)
+    GET    /api/${endpoint}/<id>       → Get single record
+    POST   /api/${endpoint}            → Create record
+    PUT    /api/${endpoint}/<id>       → Update record
+    DELETE /api/${endpoint}/<id>       → Delete record
+    POST   /api/${endpoint}/<id>/action → Call business action
+"""
+import json
+import logging
+
+from odoo import http
+from odoo.http import request, Response
+from odoo.exceptions import (
+    AccessDenied,
+    AccessError,
+    MissingError,
+    ValidationError,
+    UserError,
+)
+
+_logger = logging.getLogger(__name__)
+
+# Fields returned by default in list/detail endpoints
+_DEFAULT_FIELDS = [
+    'id', 'name', 'reference', 'state', 'description',
+    'user_id', 'company_id', 'date_start', 'date_end',
+    'priority', 'active', 'create_date', 'write_date',
+]
+
+_LIST_FIELDS = [
+    'id', 'name', 'reference', 'state', 'user_id',
+    'date_start', 'date_end', 'priority',
+]
+
+
+class ${P}RestController(http.Controller):
+    """Full CRUD REST API for ${L}."""
+
+    # ── Helpers ───────────────────────────────────────────────────────────────
+
+    @staticmethod
+    def _ok(data=None, status=200, meta=None):
+        """Build a standardised success JSON response."""
+        payload = {'status': 'success', 'data': data}
+        if meta:
+            payload['meta'] = meta
+        return Response(
+            json.dumps(payload, default=str),
+            status=status,
+            headers={'Content-Type': 'application/json; charset=utf-8'},
+        )
+
+    @staticmethod
+    def _err(message, status=400, code=None):
+        """Build a standardised error JSON response."""
+        payload = {'status': 'error', 'message': str(message)}
+        if code:
+            payload['code'] = code
+        return Response(
+            json.dumps(payload),
+            status=status,
+            headers={'Content-Type': 'application/json; charset=utf-8'},
+        )
+
+    def _get_record(self, record_id):
+        """Fetch a record by ID, raise 404 if not found."""
+        try:
+            record = request.env['${M}'].browse(int(record_id))
+            if not record.exists():
+                return None, self._err(f'Record {record_id} not found', 404)
+            return record, None
+        except (ValueError, TypeError):
+            return None, self._err('Invalid ID format', 400)
+
+    # ── LIST — GET /api/${endpoint} ──────────────────────────────────────────
+    @http.route(
+        '/api/${endpoint}',
+        auth='user',
+        methods=['GET'],
+        csrf=False,
+        cors='*',
+    )
+    def list_records(self, **kwargs):
+        """
+        List ${L} records with optional filtering and pagination.
+
+        Query params:
+            limit   (int)   Max records to return. Default: 80
+            offset  (int)   Pagination offset. Default: 0
+            state   (str)   Filter by state (draft|confirmed|in_progress|done|cancelled)
+            search  (str)   Search in name field
+            order   (str)   Sort order e.g. "name asc". Default: "name asc"
+        """
+        try:
+            limit  = min(int(kwargs.get('limit',  80)),  500)
+            offset = max(int(kwargs.get('offset', 0)),   0)
+            order  = kwargs.get('order', 'name asc')
+
+            domain = [('active', '=', True)]
+            if kwargs.get('state'):
+                domain.append(('state', '=', kwargs['state']))
+            if kwargs.get('search'):
+                domain.append(('name', 'ilike', kwargs['search']))
+
+            Model  = request.env['${M}']
+            total  = Model.search_count(domain)
+            records = Model.search_read(
+                domain=domain,
+                fields=_LIST_FIELDS,
+                limit=limit,
+                offset=offset,
+                order=order,
+            )
+
+            return self._ok(
+                data=records,
+                meta={
+                    'total': total,
+                    'limit': limit,
+                    'offset': offset,
+                    'returned': len(records),
+                },
+            )
+        except AccessError as e:
+            return self._err(str(e), 403)
+        except Exception as e:
+            _logger.exception('Error listing ${M} records')
+            return self._err(str(e), 500)
+
+    # ── GET SINGLE — GET /api/${endpoint}/<id> ───────────────────────────────
+    @http.route(
+        '/api/${endpoint}/<int:record_id>',
+        auth='user',
+        methods=['GET'],
+        csrf=False,
+        cors='*',
+    )
+    def get_record(self, record_id, **kwargs):
+        """Return a single ${L} record by ID."""
+        try:
+            record, err = self._get_record(record_id)
+            if err:
+                return err
+            fields = kwargs.get('fields', '').split(',') if kwargs.get('fields') else _DEFAULT_FIELDS
+            fields = [f.strip() for f in fields if f.strip()]
+            return self._ok(record.read(fields)[0])
+        except AccessError as e:
+            return self._err(str(e), 403)
+        except Exception as e:
+            _logger.exception('Error reading ${M} record %s', record_id)
+            return self._err(str(e), 500)
+
+    # ── CREATE — POST /api/${endpoint} ───────────────────────────────────────
+    @http.route(
+        '/api/${endpoint}',
+        auth='user',
+        methods=['POST'],
+        csrf=False,
+        cors='*',
+        type='json',
+    )
+    def create_record(self, **kwargs):
+        """
+        Create a new ${L} record.
+        Body (JSON): { name, description, date_start, date_end, priority, ... }
+        """
+        try:
+            data = request.jsonrequest or {}
+            if not data.get('name'):
+                return {'status': 'error', 'message': "'name' field is required"}
+            record = request.env['${M}'].create(data)
+            return {
+                'status': 'success',
+                'data': {'id': record.id, 'reference': record.reference, 'name': record.name},
+            }
+        except ValidationError as e:
+            return {'status': 'error', 'message': str(e), 'code': 'validation_error'}
+        except AccessError as e:
+            return {'status': 'error', 'message': str(e), 'code': 'access_denied'}
+        except Exception as e:
+            _logger.exception('Error creating ${M} record')
+            return {'status': 'error', 'message': str(e)}
+
+    # ── UPDATE — PUT /api/${endpoint}/<id> ───────────────────────────────────
+    @http.route(
+        '/api/${endpoint}/<int:record_id>',
+        auth='user',
+        methods=['PUT'],
+        csrf=False,
+        cors='*',
+        type='json',
+    )
+    def update_record(self, record_id, **kwargs):
+        """
+        Update an existing ${L} record.
+        Body (JSON): fields to update.
+        """
+        try:
+            record, err = self._get_record(record_id)
+            if err:
+                return {'status': 'error', 'message': f'Record {record_id} not found'}
+            data = request.jsonrequest or {}
+            # Protect immutable fields
+            for field in ('id', 'reference', 'create_date', 'write_date'):
+                data.pop(field, None)
+            record.write(data)
+            return {'status': 'success', 'data': {'id': record_id, 'updated': True}}
+        except ValidationError as e:
+            return {'status': 'error', 'message': str(e), 'code': 'validation_error'}
+        except AccessError as e:
+            return {'status': 'error', 'message': str(e), 'code': 'access_denied'}
+        except Exception as e:
+            _logger.exception('Error updating ${M} record %s', record_id)
+            return {'status': 'error', 'message': str(e)}
+
+    # ── DELETE — DELETE /api/${endpoint}/<id> ────────────────────────────────
+    @http.route(
+        '/api/${endpoint}/<int:record_id>',
+        auth='user',
+        methods=['DELETE'],
+        csrf=False,
+        cors='*',
+    )
+    def delete_record(self, record_id, **kwargs):
+        """Delete a ${L} record."""
+        try:
+            record, err = self._get_record(record_id)
+            if err:
+                return err
+            if record.state not in ('draft', 'cancelled'):
+                return self._err(
+                    f'Cannot delete record in state "{record.state}". Cancel it first.', 409
+                )
+            record.unlink()
+            return self._ok({'deleted': True, 'id': record_id})
+        except AccessError as e:
+            return self._err(str(e), 403)
+        except Exception as e:
+            _logger.exception('Error deleting ${M} record %s', record_id)
+            return self._err(str(e), 500)
+
+    # ── ACTION — POST /api/${endpoint}/<id>/action ───────────────────────────
+    @http.route(
+        '/api/${endpoint}/<int:record_id>/action',
+        auth='user',
+        methods=['POST'],
+        csrf=False,
+        cors='*',
+        type='json',
+    )
+    def call_action(self, record_id, **kwargs):
+        """
+        Call a business method on a record.
+        Body (JSON): { "action": "confirm" | "cancel" | "done" | "reset_draft" }
+        """
+        ALLOWED_ACTIONS = {
+            'confirm':    'action_confirm',
+            'start':      'action_start',
+            'done':       'action_done',
+            'cancel':     'action_cancel',
+            'reset_draft': 'action_reset_draft',
+        }
+        try:
+            data   = request.jsonrequest or {}
+            action = data.get('action', '').strip()
+            if action not in ALLOWED_ACTIONS:
+                return {
+                    'status': 'error',
+                    'message': f'Unknown action "{action}". Allowed: {list(ALLOWED_ACTIONS)}',
+                }
+            record, err = self._get_record(record_id)
+            if err:
+                return {'status': 'error', 'message': f'Record {record_id} not found'}
+            getattr(record, ALLOWED_ACTIONS[action])()
+            return {'status': 'success', 'data': {'id': record_id, 'state': record.state}}
+        except UserError as e:
+            return {'status': 'error', 'message': str(e), 'code': 'user_error'}
+        except AccessError as e:
+            return {'status': 'error', 'message': str(e), 'code': 'access_denied'}
+        except Exception as e:
+            _logger.exception('Error calling action on ${M} record %s', record_id)
+            return {'status': 'error', 'message': str(e)}
+
+    # ── STATS — GET /api/${endpoint}/stats ───────────────────────────────────
+    @http.route(
+        '/api/${endpoint}/stats',
+        auth='user',
+        methods=['GET'],
+        csrf=False,
+        cors='*',
+    )
+    def get_stats(self, **kwargs):
+        """Return aggregate stats grouped by state."""
+        try:
+            Model  = request.env['${M}']
+            states = ['draft', 'confirmed', 'in_progress', 'done', 'cancelled']
+            stats  = {s: Model.search_count([('state', '=', s)]) for s in states}
+            stats['total'] = Model.search_count([])
+            return self._ok(stats)
+        except Exception as e:
+            return self._err(str(e), 500)
+`;
+}
+
+module.exports = { generateApiLayer };