@planu/cli 1.1.2 → 1.3.0

package/src/config/spec-cookbook.json

@@ -0,0 +1,341 @@
+{
+  "version": "1.0.0",
+  "entries": [
+    {
+      "id": "ecommerce-user-auth",
+      "domain": "ecommerce",
+      "featureType": "auth",
+      "title": "User Authentication & Registration",
+      "description": "Implement user registration, login, and password reset flow with JWT tokens.",
+      "acceptanceCriteria": [
+        "User can register with email and password",
+        "User can login and receive JWT token",
+        "User can reset password via email",
+        "Invalid credentials return 401 with descriptive error",
+        "JWT tokens expire after 24 hours"
+      ],
+      "tags": ["auth", "users", "jwt"],
+      "estimatedEffort": "3-5 days"
+    },
+    {
+      "id": "ecommerce-payments",
+      "domain": "ecommerce",
+      "featureType": "payments",
+      "title": "Payment Processing with Stripe",
+      "description": "Integrate Stripe for one-time payments and subscription management.",
+      "acceptanceCriteria": [
+        "User can complete checkout with credit card via Stripe",
+        "Payment confirmation email sent on success",
+        "Failed payments return actionable error messages",
+        "Webhook handler processes Stripe events reliably",
+        "Refund flow supported for order cancellations"
+      ],
+      "tags": ["payments", "stripe", "billing"],
+      "estimatedEffort": "5-8 days"
+    },
+    {
+      "id": "ecommerce-cart",
+      "domain": "ecommerce",
+      "featureType": "cart",
+      "title": "Shopping Cart Management",
+      "description": "Persistent shopping cart with add, remove, and quantity update operations.",
+      "acceptanceCriteria": [
+        "User can add items to cart",
+        "User can update item quantities",
+        "User can remove items from cart",
+        "Cart persists across sessions for authenticated users",
+        "Cart shows real-time subtotal and item count"
+      ],
+      "tags": ["cart", "shopping", "persistence"],
+      "estimatedEffort": "3-4 days"
+    },
+    {
+      "id": "ecommerce-search",
+      "domain": "ecommerce",
+      "featureType": "search",
+      "title": "Product Search & Filtering",
+      "description": "Full-text search with filters for category, price range, and availability.",
+      "acceptanceCriteria": [
+        "User can search products by keyword",
+        "Results can be filtered by category, price range, and availability",
+        "Search returns results in under 500ms",
+        "Empty state shown with suggestions when no results found",
+        "Pagination supported for large result sets"
+      ],
+      "tags": ["search", "filtering", "products"],
+      "estimatedEffort": "4-6 days"
+    },
+    {
+      "id": "ecommerce-inventory",
+      "domain": "ecommerce",
+      "featureType": "inventory",
+      "title": "Inventory Management",
+      "description": "Track product stock levels with low-stock alerts and automatic out-of-stock handling.",
+      "acceptanceCriteria": [
+        "Stock quantity decremented on successful order",
+        "Out-of-stock products cannot be added to cart",
+        "Low-stock alerts triggered below configurable threshold",
+        "Admin can manually adjust stock levels",
+        "Stock history log maintained for auditing"
+      ],
+      "tags": ["inventory", "stock", "admin"],
+      "estimatedEffort": "3-5 days"
+    },
+    {
+      "id": "saas-billing",
+      "domain": "saas",
+      "featureType": "billing",
+      "title": "SaaS Subscription Billing",
+      "description": "Tiered subscription billing with plan upgrades, downgrades, and cancellations.",
+      "acceptanceCriteria": [
+        "User can subscribe to a plan",
+        "User can upgrade or downgrade plan with proration",
+        "User can cancel subscription (immediate or end-of-period)",
+        "Invoice history accessible from account settings",
+        "Failed payments trigger retry logic and user notification"
+      ],
+      "tags": ["billing", "subscriptions", "saas"],
+      "estimatedEffort": "5-7 days"
+    },
+    {
+      "id": "saas-onboarding",
+      "domain": "saas",
+      "featureType": "onboarding",
+      "title": "User Onboarding Flow",
+      "description": "Guided onboarding wizard with progress tracking and contextual tooltips.",
+      "acceptanceCriteria": [
+        "New users guided through 3-5 step onboarding wizard",
+        "Progress persisted so users can resume onboarding",
+        "Each step includes contextual help text",
+        "Onboarding can be skipped and revisited later",
+        "Completion triggers welcome email and first-use analytics event"
+      ],
+      "tags": ["onboarding", "ux", "retention"],
+      "estimatedEffort": "3-4 days"
+    },
+    {
+      "id": "saas-team-management",
+      "domain": "saas",
+      "featureType": "team-mgmt",
+      "title": "Team & Workspace Management",
+      "description": "Invite team members, assign roles, and manage workspace access.",
+      "acceptanceCriteria": [
+        "Workspace owner can invite members by email",
+        "Invited members receive email with accept link",
+        "Roles: owner, admin, member with defined permissions",
+        "Owner can remove members from workspace",
+        "Billing seats updated automatically on member changes"
+      ],
+      "tags": ["teams", "rbac", "workspaces"],
+      "estimatedEffort": "5-7 days"
+    },
+    {
+      "id": "saas-analytics",
+      "domain": "saas",
+      "featureType": "analytics",
+      "title": "Usage Analytics Dashboard",
+      "description": "Display key product usage metrics with time series charts and export.",
+      "acceptanceCriteria": [
+        "Dashboard shows DAU, MAU, and feature usage metrics",
+        "Time range selector (7d, 30d, 90d, custom)",
+        "Data refreshes on page load with loading states",
+        "Admin can export analytics as CSV",
+        "Metrics broken down by plan tier"
+      ],
+      "tags": ["analytics", "dashboard", "metrics"],
+      "estimatedEffort": "4-6 days"
+    },
+    {
+      "id": "saas-notifications",
+      "domain": "saas",
+      "featureType": "notifications",
+      "title": "In-App Notification System",
+      "description": "Real-time in-app notifications with read/unread state and notification preferences.",
+      "acceptanceCriteria": [
+        "Users receive in-app notifications for key events",
+        "Notifications marked as read on click",
+        "Unread count badge visible in navigation",
+        "Users can configure notification preferences",
+        "Notifications older than 30 days auto-archived"
+      ],
+      "tags": ["notifications", "real-time", "ux"],
+      "estimatedEffort": "3-5 days"
+    },
+    {
+      "id": "mobile-push-notifications",
+      "domain": "mobile",
+      "featureType": "push-notif",
+      "title": "Push Notification Integration",
+      "description": "Cross-platform push notifications via FCM/APNs with opt-in flow.",
+      "acceptanceCriteria": [
+        "User prompted to allow push notifications on first launch",
+        "Device token registered with backend on permission grant",
+        "Notifications delivered on iOS and Android",
+        "Users can opt out from settings",
+        "Deep-link routing from notification tap"
+      ],
+      "tags": ["push", "fcm", "apns", "mobile"],
+      "estimatedEffort": "4-6 days"
+    },
+    {
+      "id": "mobile-offline-mode",
+      "domain": "mobile",
+      "featureType": "offline-mode",
+      "title": "Offline Mode & Data Sync",
+      "description": "Local data caching with background sync when connectivity is restored.",
+      "acceptanceCriteria": [
+        "Core features accessible without internet connection",
+        "Data changes queued locally when offline",
+        "Sync triggered automatically on reconnect",
+        "Conflict resolution strategy defined and implemented",
+        "Sync status indicator visible in UI"
+      ],
+      "tags": ["offline", "sync", "caching"],
+      "estimatedEffort": "7-10 days"
+    },
+    {
+      "id": "mobile-biometric-auth",
+      "domain": "mobile",
+      "featureType": "auth",
+      "title": "Biometric Authentication",
+      "description": "TouchID/FaceID authentication as an alternative to password login.",
+      "acceptanceCriteria": [
+        "User can enable biometric auth from settings",
+        "Biometric prompt shown on app launch when enabled",
+        "Falls back to PIN/password on biometric failure",
+        "Biometric auth disabled automatically after 3 failures",
+        "Settings clearly explain data stored locally"
+      ],
+      "tags": ["biometrics", "touchid", "faceid", "auth"],
+      "estimatedEffort": "2-3 days"
+    },
+    {
+      "id": "api-rate-limiting",
+      "domain": "api",
+      "featureType": "rate-limiting",
+      "title": "API Rate Limiting",
+      "description": "Token bucket rate limiting per API key with headers and 429 responses.",
+      "acceptanceCriteria": [
+        "Rate limits enforced per API key",
+        "X-RateLimit-Limit and X-RateLimit-Remaining headers returned",
+        "429 response with Retry-After header when limit exceeded",
+        "Limits configurable per plan tier",
+        "Rate limit state persisted in Redis or equivalent"
+      ],
+      "tags": ["rate-limiting", "api", "security"],
+      "estimatedEffort": "2-3 days"
+    },
+    {
+      "id": "api-auth",
+      "domain": "api",
+      "featureType": "auth",
+      "title": "API Key Authentication",
+      "description": "Secure API key generation, rotation, and scoped permissions.",
+      "acceptanceCriteria": [
+        "Users can generate API keys from dashboard",
+        "API keys support scoped permissions (read/write)",
+        "Keys can be revoked immediately",
+        "Last-used timestamp tracked per key",
+        "Keys shown only once at creation; hashed at rest"
+      ],
+      "tags": ["api-keys", "auth", "security"],
+      "estimatedEffort": "2-4 days"
+    },
+    {
+      "id": "api-pagination",
+      "domain": "api",
+      "featureType": "pagination",
+      "title": "Cursor-based Pagination",
+      "description": "Efficient cursor-based pagination for large dataset endpoints.",
+      "acceptanceCriteria": [
+        "All list endpoints support cursor-based pagination",
+        "Response includes next_cursor and has_more fields",
+        "Page size configurable via limit parameter (max 100)",
+        "Stable sort order guaranteed across pages",
+        "Deprecated offset pagination removed or hidden behind flag"
+      ],
+      "tags": ["pagination", "api", "performance"],
+      "estimatedEffort": "1-2 days"
+    },
+    {
+      "id": "api-webhooks",
+      "domain": "api",
+      "featureType": "webhooks",
+      "title": "Outbound Webhook Delivery",
+      "description": "Reliable webhook delivery with retries, signing, and delivery log.",
+      "acceptanceCriteria": [
+        "Events trigger webhook delivery to configured URLs",
+        "HMAC-SHA256 signature included in X-Signature header",
+        "Failed deliveries retried up to 5 times with exponential backoff",
+        "Delivery log shows status, response code, and duration",
+        "Users can test webhooks from the dashboard"
+      ],
+      "tags": ["webhooks", "events", "reliability"],
+      "estimatedEffort": "3-5 days"
+    },
+    {
+      "id": "fintech-kyc",
+      "domain": "fintech",
+      "featureType": "kyc",
+      "title": "KYC Identity Verification",
+      "description": "Know Your Customer flow with document upload and third-party verification.",
+      "acceptanceCriteria": [
+        "User can upload government ID and selfie",
+        "Third-party KYC provider called for verification",
+        "User notified of verification result within 24 hours",
+        "Unverified users restricted from financial operations",
+        "KYC status stored and auditable"
+      ],
+      "tags": ["kyc", "compliance", "identity"],
+      "estimatedEffort": "5-8 days"
+    },
+    {
+      "id": "fintech-transactions",
+      "domain": "fintech",
+      "featureType": "transactions",
+      "title": "Transaction Ledger",
+      "description": "Append-only transaction ledger with balance calculation and history export.",
+      "acceptanceCriteria": [
+        "All financial operations create immutable ledger entries",
+        "Account balance computed from ledger in real time",
+        "Transaction history filterable by date and type",
+        "Export to CSV and PDF supported",
+        "Transactions signed and tamper-evident"
+      ],
+      "tags": ["ledger", "transactions", "audit"],
+      "estimatedEffort": "5-7 days"
+    },
+    {
+      "id": "fintech-compliance",
+      "domain": "fintech",
+      "featureType": "compliance",
+      "title": "Regulatory Compliance Reporting",
+      "description": "Automated compliance reports (AML, SAR) with configurable thresholds.",
+      "acceptanceCriteria": [
+        "Transactions above threshold flagged for review",
+        "AML report generated on demand and on schedule",
+        "Suspicious activity report (SAR) workflow supported",
+        "Reports stored with audit trail",
+        "Configurable thresholds per jurisdiction"
+      ],
+      "tags": ["compliance", "aml", "reporting"],
+      "estimatedEffort": "7-10 days"
+    },
+    {
+      "id": "fintech-fraud-detection",
+      "domain": "fintech",
+      "featureType": "fraud",
+      "title": "Fraud Detection & Scoring",
+      "description": "Real-time fraud scoring for transactions with rule-based and ML signals.",
+      "acceptanceCriteria": [
+        "Each transaction assigned a fraud risk score (0-100)",
+        "High-risk transactions flagged for manual review",
+        "Rule engine configurable via admin interface",
+        "Score rationale logged for explainability",
+        "False-positive rate tracked and reported weekly"
+      ],
+      "tags": ["fraud", "risk", "ml"],
+      "estimatedEffort": "8-12 days"
+    }
+  ]
+}