ai-spector 0.1.0

package/templates/basic_design/detail-api-template.md

@@ -0,0 +1,278 @@
+# API Detail: <Project Name>
+
+> This document specifies detailed request/response schemas, path/query parameters, and error handling for each API endpoint. For the endpoint list and overview, see the API List document.
+
+**Source Requirements:** SRS Section 4 (System Features), Section 6.2 (Software Interfaces)
+
+---
+
+## 1. Detailed Endpoint Specifications
+
+### 1.1 `POST /resource`
+
+**Summary:** <Brief description>
+
+**Operation ID:** `createResource`
+
+**Source Requirement:** SRS Section <X.X> - <Feature Name>
+
+**Authentication:** Required
+
+**Request:**
+
+**Headers:**
+```
+Authorization: Bearer <token>
+Content-Type: application/json
+```
+
+**Body Schema:**
+```json
+{
+  "field1": "<type>",
+  "field2": "<type>",
+  "field3": "<type>"
+}
+```
+
+**Field Descriptions:**
+
+| Field | Type | Required | Validation | Description |
+|-------|------|----------|------------|-------------|
+| `field1` | `<type>` | Yes | <Validation rules> | <Description> |
+| `field2` | `<type>` | No | <Validation rules> | <Description> |
+
+**Example Request:**
+```json
+{
+  "field1": "value1",
+  "field2": "value2"
+}
+```
+
+**Responses:**
+
+**201 Created:**
+```json
+{
+  "id": 123,
+  "status": "success",
+  "message": "<Message>"
+}
+```
+
+**400 Bad Request:**
+```json
+{
+  "error": "validation_error",
+  "message": "<Error message>",
+  "details": [
+    {
+      "field": "field1",
+      "message": "<Field-specific error>"
+    }
+  ]
+}
+```
+
+**401 Unauthorized:**
+```json
+{
+  "error": "unauthorized",
+  "message": "Authentication required"
+}
+```
+
+**500 Internal Server Error:**
+```json
+{
+  "error": "internal_error",
+  "message": "<Error message>"
+}
+```
+
+---
+
+### 1.2 `GET /resource/{id}`
+
+**Summary:** <Brief description>
+
+**Operation ID:** `getResource`
+
+**Source Requirement:** SRS Section <X.X>
+
+**Authentication:** Required
+
+**Path Parameters:**
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `id` | integer | Yes | Resource identifier |
+
+**Query Parameters:**
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `include` | string | No | Related resources to include |
+| `fields` | string | No | Fields to return |
+
+**Responses:**
+
+**200 OK:**
+```json
+{
+  "id": 123,
+  "field1": "value1",
+  "field2": "value2",
+  "created_at": "2025-01-01T00:00:00Z"
+}
+```
+
+**404 Not Found:**
+```json
+{
+  "error": "not_found",
+  "message": "Resource not found"
+}
+```
+
+---
+
+### 1.3 `PUT /resource/{id}`
+
+**Summary:** <Brief description>
+
+**Operation ID:** `updateResource`
+
+**Authentication:** Required
+
+**Path Parameters:**
+- `id`: Resource identifier
+
+**Request Body:**
+> Similar structure to POST
+
+**Responses:**
+> Similar structure to GET/POST
+
+---
+
+### 1.4 `DELETE /resource/{id}`
+
+**Summary:** <Brief description>
+
+**Operation ID:** `deleteResource`
+
+**Authentication:** Required
+
+**Path Parameters:**
+- `id`: Resource identifier
+
+**Responses:**
+
+**204 No Content:**
+> Success response with no body
+
+**404 Not Found:**
+> Error response
+
+---
+
+## 2. Data Models
+
+### 2.1 Resource Model
+
+**Description:** <Description of the data model>
+
+**Schema:**
+```json
+{
+  "id": "integer",
+  "field1": "string",
+  "field2": "integer",
+  "created_at": "datetime",
+  "updated_at": "datetime"
+}
+```
+
+**Field Details:**
+
+| Field | Type | Description | Constraints |
+|-------|------|-------------|-------------|
+| `id` | integer | Unique identifier | Auto-generated |
+| `field1` | string | <Description> | Max 255 chars |
+| `field2` | integer | <Description> | Min 0, Max 100 |
+
+---
+
+## 3. Error Handling
+
+**Standard Error Response Format:**
+```json
+{
+  "error": "<error_code>",
+  "message": "<Human-readable message>",
+  "details": {
+    "<additional_info>": "<value>"
+  }
+}
+```
+
+**Error Codes:**
+
+| Code | HTTP Status | Description |
+|------|-------------|-------------|
+| `validation_error` | 400 | Request validation failed |
+| `unauthorized` | 401 | Authentication required |
+| `forbidden` | 403 | Insufficient permissions |
+| `not_found` | 404 | Resource not found |
+| `conflict` | 409 | Resource conflict |
+| `internal_error` | 500 | Server error |
+
+---
+
+## 4. Rate Limiting
+
+**Limits:**
+- <Limit description>
+
+**Headers:**
+```
+X-RateLimit-Limit: <number>
+X-RateLimit-Remaining: <number>
+X-RateLimit-Reset: <timestamp>
+```
+
+**Response when limit exceeded:**
+```json
+{
+  "error": "rate_limit_exceeded",
+  "message": "Too many requests",
+  "retry_after": 60
+}
+```
+
+---
+
+## 5. Webhooks (if applicable)
+
+**Events:**
+- `<event_name>`: <Description>
+
+**Payload Format:**
+```json
+{
+  "event": "<event_name>",
+  "timestamp": "<ISO 8601>",
+  "data": {
+    "<resource_data>": "..."
+  }
+}
+```
+
+---
+
+## 6. Future Enhancements
+
+- <Enhancement 1>
+- <Enhancement 2>

package/templates/basic_design/detail-screen-template.md

@@ -0,0 +1,281 @@
+# Screen Detail:
+
+> This document provides detailed layout, component, and interaction specifications for each screen. For the screen map and design system, see the Screen Map (List Screen) document. Use one section per screen; duplicate the structure below for each screen in the Screen Index.
+
+**Source Requirements:** SRS Section 6.1 (User Interfaces)
+
+---
+
+## 1. Screen:
+
+**Purpose:**
+
+> Describe the purpose of this screen and what users can accomplish.
+
+**User Role:** 
+
+**Source Requirements:** SRS Section <X.X> - 
+
+### 1.1 Visual Wireframe
+
+> Use ASCII art or grid-based layout to show the visual structure. You can also reference an image file or Figma link.
+
+**Option 1: ASCII Wireframe**
+
+```
+┌─────────────────────────────────────────────────────────┐
+│  [Logo]                    [User Menu] [Notifications]  │ ← Header (60px)
+├──────────┬───────────────────────────────────────────────┤
+│          │                                               │
+│  Nav     │          Main Content Area                    │
+│  Menu    │          ┌─────────────────┐                 │
+│          │          │  Card/Component │                 │
+│  Item 1  │          │                 │                 │
+│  Item 2  │          └─────────────────┘                 │
+│  Item 3  │          ┌─────────────────┐                 │
+│          │          │  Card/Component │                 │
+│          │          │                 │                 │
+│          │          └─────────────────┘                 │
+│          │                                               │
+├──────────┴───────────────────────────────────────────────┤
+│  Footer Content                                           │ ← Footer (40px)
+└─────────────────────────────────────────────────────────┘
+```
+
+**Option 2: Grid Layout Description**
+
+```
+┌─────────────────────────────────────────────────────────┐
+│ HEADER (100% width, 60px height)                        │
+│ [Logo: 200px] [Spacer] [User Menu: 150px] [Notif: 50px] │
+├─────────────────────────────────────────────────────────┤
+│ SIDEBAR │ MAIN CONTENT (flex: 1)                         │
+│ (250px) │ ┌───────────────────────────────────────────┐ │
+│         │ │ STATS CARDS (3 columns, equal width)        │ │
+│ Nav     │ │ [Card 1] [Card 2] [Card 3]                │ │
+│ Menu    │ └───────────────────────────────────────────┘ │
+│         │ ┌───────────────────────────────────────────┐ │
+│ Item 1  │ │ TABLE/LIST (full width)                    │ │
+│ Item 2  │ │ [Row 1] [Row 2] [Row 3]                   │ │
+│         │ └───────────────────────────────────────────┘ │
+└─────────┴───────────────────────────────────────────────┘
+```
+
+**Option 3: Image Reference**
+
+> **Wireframe Image:** `[screens/screen-name-wireframe.png]` or `[Figma Link]`
+>
+> **High-Fidelity Mockup:** `[screens/screen-name-mockup.png]` or `[Figma Link]`
+
+### 1.2 Layout Structure
+
+
+| Component        | Position        | Width/Height | Description |
+| ---------------- | --------------- | ------------ | ----------- |
+| **Header**       | Top             | 100% × 60px  |             |
+| **Navigation**   | <Left/Side/Top> | 250px × auto |             |
+| **Main Content** | Center          | flex: 1      |             |
+| **Sidebar**      | <Right/Left>    | 300px × auto |             |
+| **Footer**       | Bottom          | 100% × 40px  |             |
+
+
+### 1.3 Component Details
+
+**Header:**
+
+- Logo: 
+- User menu: 
+- Notifications:
+
+**Main Content Area:**
+
+
+| Component          | Description | Visual Style |
+| ------------------ | ----------- | ------------ |
+| **Component Name** | Description | Style notes  |
+
+
+**Key Components:**
+
+**Component Name:**
+
+- **Purpose:** What it does
+- **Visual Representation:**
+  ```
+  ┌─────────────────────────────┐
+  │ [Icon] Title Text            │
+  │ ───────────────────────────  │
+  │ Content area                 │
+  │ [Button] [Button]            │
+  └─────────────────────────────┘
+  ```
+- **Elements:**
+  - <Element 1>:  (Position: <top/left/right>, Size: )
+  - <Element 2>:  (Position: <top/left/right>, Size: )
+- **Visual Style:**
+  - Background: 
+  - Border: <1px solid color>
+  - Padding: <16px>
+  - Margin: <8px>
+  - Border radius: <4px>
+- **Dimensions:** <Width × Height>
+- **Interaction:**
+
+### 1.4 User Interactions
+
+**Primary Actions:**
+
+- <Action 1>: 
+- <Action 2>:
+
+**Navigation Flow:**
+
+- From this screen, users can navigate to:
+  - <Screen/Page>: 
+  - <Screen/Page>:
+
+**Form Layout (if applicable):**
+
+```
+┌─────────────────────────────────────┐
+│ Form Title                           │
+│ ───────────────────────────────────  │
+│ [Label]                              │
+│ ┌─────────────────────────────────┐ │
+│ │ Input Field                     │ │
+│ └─────────────────────────────────┘ │
+│ [Label]                              │
+│ ┌─────────────────────────────────┐ │
+│ │ Dropdown/Select                 │ │
+│ └─────────────────────────────────┘ │
+│                                      │
+│ [Cancel] [Submit Button]             │
+└─────────────────────────────────────┘
+```
+
+**Form Interactions:**
+
+- :
+- :
+
+### 1.5 Field Validation and Default Data
+
+> This section documents validation rules and default values for all input fields on this screen.
+>
+> **Note:** If this screen has no input fields or forms, this section can be omitted or marked as "N/A - No input fields on this screen."
+
+**Field Validation and Default Data:**
+
+
+| Field Name | Field Type                        | Required | Default Value              | Default Source                          | Validation Rules | Error Messages | Notes |
+| ---------- | --------------------------------- | -------- | -------------------------- | --------------------------------------- | ---------------- | -------------- | ----- |
+|            | <Text/Email/Number/Date/Dropdown> | <Yes/No> | <Default value or "Empty"> | <Auto-generated/System/User preference> |                  |                |       |
+
+
+**Detailed Field Information:**
+
+**:**
+
+- **Type:** 
+- **Required:** <Yes/No>
+- **Default Value:** <Value or "Empty">
+- **Default Source:** 
+- **Min Length:**  characters
+- **Max Length:**  characters
+- **Pattern/Format:** 
+- **Custom Validation:** 
+- **Error Messages:**
+  - Required: ""
+  - Format: ""
+  - Custom: ""
+- **Real-time Validation:** <Yes/No - validates on blur/on change>
+- **Dependencies:** 
+- **Notes:**
+
+ **(Dropdown):**
+
+- **Type:** Dropdown/Select
+- **Required:** <Yes/No>
+- **Default Value:** 
+- **Default Source:** <System/First option/User preference>
+- **Options Source:** <Static list/Dynamic from API/User selection>
+- **Options:**
+  - : -
+  - : -
+- **Dependencies:** 
+- **Validation Rules:** 
+- **Error Messages:**
+
+---
+
+## 2. Screen:
+
+**Purpose:**
+
+> Describe the purpose of this screen.
+
+**User Role:** 
+
+**Source Requirements:** SRS Section <X.X>
+
+### 2.1 Visual Wireframe
+
+```
+┌─────────────────────────────────────────────────────────┐
+│ [Screen Layout - Use ASCII art or reference image]       │
+└─────────────────────────────────────────────────────────┘
+```
+
+**Wireframe Image:** `[screens/screen-name-wireframe.png]` or `[Figma Link]`
+
+### 2.2 Layout Structure
+
+
+| Component | Position | Width/Height | Description |
+| --------- | -------- | ------------ | ----------- |
+|           |          |              |             |
+
+
+### 2.3 Component Details
+
+**:**
+
+- **Purpose:** 
+- **Visual Representation:**
+  ```
+  ┌─────────────────────────────┐
+  │ Component Layout             │
+  └─────────────────────────────┘
+  ```
+- **Elements:**
+  - <Element 1>
+  - <Element 2>
+- **Visual Style:** 
+- **Dimensions:** <Width × Height>
+- **Interaction:**
+
+### 2.4 User Interactions
+
+**Primary Actions:**
+
+- <Action 1>
+- <Action 2>
+
+---
+
+## 3. Screen:
+
+**Purpose:**
+
+> Describe the purpose of this screen.
+
+**User Role:** 
+
+### 3.1 Visual Wireframe
+
+### 3.2 Layout Structure
+
+---
+
+> Repeat the same section structure (Screen name → Wireframe → Layout → Component Details → User Interactions → Field Validation if applicable) for each additional screen in the Screen Index.
+

package/templates/basic_design/list-api-template.md

@@ -0,0 +1,130 @@
+# API List: 
+
+> This document provides the API overview, authentication, and a summary list of all endpoints. For detailed request/response specifications per endpoint, see the Detail API document.
+
+**Source Requirements:** SRS Section 4 (System Features), Section 6.2 (Software Interfaces)
+
+---
+
+## 1. API Overview
+
+**Base URL:** `<https://api.example.com/v1>`
+
+**API Version:** `v1.0`
+
+**Protocol:** `HTTPS`
+
+**Authentication:** <JWT/OAuth2/API Key>
+
+**Content Type:** `application/json`
+
+**Source Requirements:**
+
+- SRS Section 4: 
+- SRS Section 6.2: 
+- SRS Section 7.3: 
+
+---
+
+## 2. Authentication
+
+**Method:** <JWT Bearer Token / OAuth2 / API Key>
+
+**How to Authenticate:**
+
+> Describe the authentication flow.
+
+**Token Format:**
+
+> Describe token structure if applicable.
+
+**Example:**
+
+```http
+Authorization: Bearer <token>
+```
+
+**Token Expiration:**
+
+> Describe token expiration and refresh mechanism.
+
+---
+
+## 3. Endpoint Summary
+
+
+| Method   | Endpoint         | Description | Authentication |
+| -------- | ---------------- | ----------- | -------------- |
+| `POST`   | `/resource`      |             | Required       |
+| `GET`    | `/resource`      |             | Required       |
+| `GET`    | `/resource/{id}` |             | Required       |
+| `PUT`    | `/resource/{id}` |             | Required       |
+| `DELETE` | `/resource/{id}` |             | Required       |
+
+
+> Add one row per endpoint. For detailed specifications (request/response schemas, path/query params), see the Detail API document.
+
+---
+
+## 4. Pagination
+
+**Query Parameters:**
+
+- `page`: Page number (default: 1)
+- `per_page`: Items per page (default: 20, max: 100)
+
+**Response Format:**
+
+```json
+{
+  "data": [...],
+  "pagination": {
+    "page": 1,
+    "per_page": 20,
+    "total": 100,
+    "total_pages": 5
+  }
+}
+```
+
+---
+
+## 5. Filtering and Sorting
+
+**Query Parameters:**
+
+- `filter[field]`: Filter by field value
+- `sort`: Sort field and direction (e.g., `created_at:desc`)
+
+**Examples:**
+
+```
+GET /resource?filter[status]=active&sort=created_at:desc
+```
+
+---
+
+## 6. OpenAPI / Specification Reference
+
+> Reference or include link to OpenAPI/Swagger specification file.
+
+**Location:** `<api-spec.yaml>`
+
+**Note:** For detailed endpoint specifications, see the Detail API document.
+
+---
+
+## 7. Notes
+
+**API Versioning Strategy:**
+
+> Describe versioning approach.
+
+**Deprecation Policy:**
+
+> Describe how deprecated endpoints are handled.
+
+**Testing:**
+
+> Reference API testing documentation or Postman collection.
+