@donotdev/cli 0.0.5 → 0.0.7

package/templates/app-vite/src/pages/ListPageExample.tsx.example

@@ -0,0 +1,88 @@
+/**
+ * @fileoverview Example CRUD List Page
+ *
+ * COPY THIS FILE and rename (e.g., ProductsListPage.tsx, CustomersListPage.tsx)
+ *
+ * HOW IT WORKS:
+ * 1. Import your entity definition
+ * 2. Use EntityList component - it handles everything:
+ *    - Fetching data (optimized via listFields)
+ *    - Table columns (respects field visibility by role)
+ *    - Search, sort, pagination
+ *    - Create/Edit/Delete actions
+ */
+
+import { Package } from 'lucide-react';
+
+import { EntityList } from '@donotdev/crud';
+import { useAuth } from '@donotdev/auth';
+import type { PageMeta } from '@donotdev/core';
+import { PageContainer } from '@donotdev/ui';
+
+// Import your entity from root-level entities folder
+// import { productEntity } from 'entities/Product';
+
+// Placeholder - replace with your entity import
+const productEntity = null as any;
+
+// ============================================================================
+// PAGE METADATA
+// ============================================================================
+
+export const NAMESPACE = 'products';
+
+export const meta: PageMeta = {
+  namespace: NAMESPACE,
+  icon: <Package />,
+  route: '/products',
+  auth: { required: true, role: 'admin' }, // Admin-only page
+};
+
+// ============================================================================
+// PAGE COMPONENT
+// ============================================================================
+
+export default function ProductsListPage() {
+  const user = useAuth('user');
+
+  // Zero-Config: EntityList handles everything automatically:
+  // - Fetches data using entity's listFields (optimized query)
+  // - Renders columns based on field definitions
+  // - Applies visibility rules based on user role
+  // - Includes search, sort, pagination
+  // - Add/Edit/Delete buttons with proper permissions
+
+  return (
+    <PageContainer>
+      <EntityList
+        entity={productEntity}
+        userRole={user?.role}
+        // Optional overrides:
+        // onRowClick={(item) => navigate(`/products/${item.id}`)}
+        // createPath="/products/new"
+        // hideActions={false}
+        // pageSize={25}
+      />
+    </PageContainer>
+  );
+}
+
+// ============================================================================
+// ALTERNATIVE: Card Grid Layout
+// ============================================================================
+//
+// For a card-based grid instead of table:
+//
+// import { EntityCardList } from '@donotdev/crud';
+//
+// export default function ProductsGridPage() {
+//   return (
+//     <PageContainer>
+//       <EntityCardList
+//         entity={productEntity}
+//         // Optional: custom card rendering
+//         // renderCard={(item) => <CustomProductCard product={item} />}
+//       />
+//     </PageContainer>
+//   );
+// }

package/templates/functions-firebase/README.md.example

@@ -2,6 +2,31 @@
 
 This directory contains the Firebase Functions for the {{APP_NAME}} app, generated using the DoNotDev framework's scaffolding system.
 
+## ⚠️ CRITICAL: Import Rules
+
+**Functions run on Node.js - you MUST use `/server` imports or your function will crash on deploy.**
+
+```typescript
+// ✅ CORRECT - Functions MUST use /server imports
+import { getFirebaseAdminAuth } from '@donotdev/firebase/server';
+import { getFirebaseAdminFirestore } from '@donotdev/firebase/server';
+import { handleError } from '@donotdev/core/server';
+
+// ❌ WRONG - This will crash on deploy (pulls in React/client code)
+import { getAuth } from '@donotdev/firebase';
+import { getFirestore } from '@donotdev/firebase';
+import { handleError } from '@donotdev/core';
+```
+
+**Why?** Functions run in Node.js, not the browser. Client imports (`@donotdev/firebase`) include React and browser-only code that will crash your function.
+
+**Rule:** Always use `/server` suffix for:
+- `@donotdev/firebase/server` (not `@donotdev/firebase`)
+- `@donotdev/core/server` (not `@donotdev/core`)
+- `@donotdev/utils/server` (not `@donotdev/utils`)
+
+---
+
 ## Structure
 
 ```

package/templates/functions-firebase/build.mjs.example

@@ -5,7 +5,9 @@
  */
 
 import { build } from 'esbuild';
-import { createAppFunctionsConfig } from '@donotdev/core/functions';
+import { writeFileSync } from 'fs';
+import { createAppFunctionsConfig, generateFunctionsYamlWithInfo } from '@donotdev/core/functions';
+import { functionsConfig } from './functions.config.js';
 
 async function buildFunctions() {
   console.log('🔨 Building {{APP_NAME}} functions...');
@@ -33,6 +35,11 @@ async function buildFunctions() {
     
     console.log('✅ {{APP_NAME}} functions built successfully!');
     console.log('📁 Output directory: lib/');
+
+    // Generate functions.yaml from config
+    const { yaml, staticFunctions, crudFunctions } = generateFunctionsYamlWithInfo(functionsConfig);
+    writeFileSync('functions.yaml', yaml);
+    console.log(`📄 Generated functions.yaml: ${staticFunctions.length} static + ${crudFunctions.length} CRUD functions`);
     
     // Log bundle info if metafile is available
     if (result.metafile) {

package/templates/functions-firebase/functions-firebase/build.mjs.example

@@ -5,7 +5,9 @@
  */
 
 import { build } from 'esbuild';
-import { createAppFunctionsConfig } from '@donotdev/core/functions';
+import { writeFileSync } from 'fs';
+import { createAppFunctionsConfig, generateFunctionsYamlWithInfo } from '@donotdev/core/functions';
+import { functionsConfig } from './functions.config.js';
 
 async function buildFunctions() {
   console.log('🔨 Building {{APP_NAME}} functions...');
@@ -33,6 +35,11 @@ async function buildFunctions() {
     
     console.log('✅ {{APP_NAME}} functions built successfully!');
     console.log('📁 Output directory: lib/');
+
+    // Generate functions.yaml from config
+    const { yaml, staticFunctions, crudFunctions } = generateFunctionsYamlWithInfo(functionsConfig);
+    writeFileSync('functions.yaml', yaml);
+    console.log(`📄 Generated functions.yaml: ${staticFunctions.length} static + ${crudFunctions.length} CRUD functions`);
     
     // Log bundle info if metafile is available
     if (result.metafile) {

package/templates/functions-firebase/functions-firebase/src/index.ts.example

@@ -2,18 +2,29 @@
 
 /**
  * @fileoverview {{APP_NAME}} Firebase Functions
- * @description {{APP_NAME}} functions that wrap framework functions with {{APP_NAME}}-specific configuration
+ * @description Auto-registered CRUD + custom functions for {{APP_NAME}}
  */
 
 import { initializeApp } from 'firebase-admin/app';
+import { registerCrudFunctions } from '@donotdev/functions/firebase';
+import * as entities from 'entities';
 
-// Initialize Firebase Admin if not already initialized
+// Initialize Firebase Admin
 if (!(globalThis as any).__FIREBASE_ADMIN_INITIALIZED__) {
   initializeApp();
   (globalThis as any).__FIREBASE_ADMIN_INITIALIZED__ = true;
 }
 
-// Export auth functions
+// ============================================================================
+// CRUD Functions (auto-registered from entities)
+// ============================================================================
+// Registers: create_cars, get_cars, list_cars, update_cars, delete_cars
+//            create_customers, get_customers, ... for each entity
+registerCrudFunctions(entities);
+
+// ============================================================================
+// Auth Functions
+// ============================================================================
 export {
   setCustomClaims,
   getCustomClaims,
@@ -21,25 +32,8 @@ export {
   getUserAuthStatus,
 } from './auth';
 
-// Export OAuth functions
-export {
-  grantGitHubAccess,
-  revokeGitHubAccess,
-  checkGitHubAccess,
-} from './oauth';
-
-// Export CRUD functions
-export {
-  createEntity,
-  updateEntity,
-  deleteEntity,
-  getEntity,
-  listEntities,
-} from './crud';
-
-// Export billing functions
-export {
-  processPaymentSuccess,
-  refreshSubscriptionStatus,
-  stripeWebhook,
-} from './billing';
+// ============================================================================
+// Custom Functions (analytics, webhooks, etc.)
+// ============================================================================
+// export { getDashboardMetrics } from './analytics';
+// export { stripeWebhook } from './billing';

package/templates/functions-firebase/functions.config.js.example

@@ -0,0 +1,35 @@
+// functions/functions.config.js
+
+/**
+ * @fileoverview {{APP_NAME}} Functions Configuration
+ * @description Configuration for Firebase Functions deployment
+ * @type {import('@donotdev/types').FunctionsConfig}
+ * 
+ * This config file is used to auto-generate functions.yaml during build.
+ * 
+ * - Static functions: List your custom functions here
+ * - CRUD functions: List entity names to auto-generate CRUD endpoints
+ *   (e.g., ['car', 'customer'] generates: create_car, get_car, list_car, update_car, delete_car, etc.)
+ */
+
+export const functionsConfig = {
+  defaults: {
+    region: ['us-central1'],
+    platform: 'gcfv2',
+    labels: { app: '{{APP_NAME}}' },
+  },
+  functions: {
+    // Add your static (non-CRUD) functions here
+    // Example:
+    // getCustomClaims: { category: 'auth' },
+    // setCustomClaims: { category: 'auth' },
+    // stripeWebhook: { category: 'billing', trigger: 'http' },
+  },
+  crud: {
+    // List entity names to auto-generate CRUD functions
+    // Each entity will generate: create_*, get_*, list_*, update_*, delete_*
+    // Example:
+    // entities: ['car', 'customer', 'inquiry'],
+    entities: [],
+  },
+};

package/templates/functions-firebase/tsconfig.json.example

@@ -1,18 +1,8 @@
 {
+  "extends": "../../../tsconfig.functions.json",
   "compilerOptions": {
-    "target": "ES2022",
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "lib": ["ES2022"],
-    "strict": true,
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "forceConsistentCasingInFileNames": true,
-    "allowSyntheticDefaultImports": true,
-    "noUncheckedIndexedAccess": true,
-    "types": ["node"],
+    "module": "preserve",
+    "moduleResolution": "bundler",
     "outDir": "./lib",
     "rootDir": "./src",
     "declaration": true,

package/templates/functions-vercel/tsconfig.json.example

@@ -1,18 +1,6 @@
 {
+  "extends": "../../../tsconfig.functions.json",
   "compilerOptions": {
-    "target": "ES2022",
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "lib": ["ES2022"],
-    "strict": true,
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "forceConsistentCasingInFileNames": true,
-    "allowSyntheticDefaultImports": true,
-    "noUncheckedIndexedAccess": true,
-    "types": ["node"],
     "outDir": "./lib",
     "rootDir": "./src",
     "declaration": true,

package/templates/root-consumer/entities/ExampleEntity.ts.example

@@ -0,0 +1,223 @@
+/**
+ * @fileoverview Example Entity Definition
+ *
+ * COPY THIS FILE and rename to your entity (e.g., Product.ts, Task.ts, Customer.ts)
+ *
+ * HOW ENTITIES WORK:
+ * 1. Define fields with types, visibility, validation
+ * 2. Set access rules (who can create/read/update/delete)
+ * 3. Choose which fields show in list vs card vs form views
+ * 4. Framework generates: Firestore queries, forms, lists, cards automatically
+ *
+ * FIRESTORE PATH: `products/{productId}` (collection name from 'collection' prop)
+ */
+
+import { defineEntity } from '@donotdev/core';
+
+// ============================================================================
+// ENTITY DEFINITION
+// ============================================================================
+
+export const productEntity = defineEntity({
+  // Entity name - used for i18n keys, display labels
+  name: 'Product',
+
+  // Firestore collection path
+  collection: 'products',
+
+  // Fields shown in EntityList table (column order matters)
+  listFields: ['name', 'category', 'price', 'status'],
+
+  // Fields shown in EntityCardList (card layout)
+  listCardFields: ['images', 'name', 'price', 'category'],
+
+  // ==========================================================================
+  // ACCESS RULES - Who can do what
+  // ==========================================================================
+  //
+  // 'guest'   → Anyone (including not logged in)
+  // 'user'    → Any logged-in user
+  // 'owner'   → Only the document owner (createdById matches)
+  // 'admin'   → Only admin role
+  //
+  access: {
+    create: 'admin',   // Only admins can create products
+    read: 'guest',     // Anyone can view products (public catalog)
+    update: 'admin',   // Only admins can edit
+    delete: 'admin',   // Only admins can delete
+  },
+
+  // ==========================================================================
+  // FIELD DEFINITIONS
+  // ==========================================================================
+  //
+  // FIELD TYPES:
+  // 'text'      → Single-line text input
+  // 'textarea'  → Multi-line text
+  // 'number'    → Numeric input
+  // 'email'     → Email with validation
+  // 'tel'       → Phone number with country picker
+  // 'select'    → Dropdown with options
+  // 'combobox'  → Searchable dropdown
+  // 'switch'    → Toggle on/off
+  // 'checkbox'  → Multiple selections
+  // 'date'      → Date picker
+  // 'timestamp' → Date + time
+  // 'images'    → Image upload (multiple)
+  // 'reference' → Link to another entity
+  //
+  // VISIBILITY:
+  // 'guest'  → Everyone can see this field
+  // 'user'   → Only logged-in users
+  // 'owner'  → Only document owner
+  // 'admin'  → Only admins
+  //
+  // EDITABLE:
+  // 'admin'       → Only admins can edit
+  // 'owner'       → Only owner can edit
+  // 'create-only' → Set on creation, read-only after
+  //
+  fields: {
+    // ==========================================================================
+    // PUBLIC FIELDS - Visible to all, editable by admin
+    // ==========================================================================
+
+    name: {
+      name: 'name',
+      label: 'name', // i18n key: products.fields.name
+      type: 'text',
+      visibility: 'guest',
+      editable: 'admin',
+      validation: { required: true },
+    },
+
+    description: {
+      name: 'description',
+      label: 'description',
+      type: 'textarea',
+      visibility: 'guest',
+      editable: 'admin',
+      validation: { required: false },
+    },
+
+    category: {
+      name: 'category',
+      label: 'category',
+      type: 'select',
+      visibility: 'guest',
+      editable: 'admin',
+      validation: {
+        required: true,
+        options: [
+          { value: 'electronics', label: 'category.electronics' },
+          { value: 'clothing', label: 'category.clothing' },
+          { value: 'home', label: 'category.home' },
+          { value: 'other', label: 'category.other' },
+        ],
+      },
+    },
+
+    price: {
+      name: 'price',
+      label: 'price',
+      type: 'number',
+      visibility: 'guest',
+      editable: 'admin',
+      validation: { required: true },
+    },
+
+    images: {
+      name: 'images',
+      label: 'images',
+      type: 'images',
+      visibility: 'guest',
+      editable: 'admin',
+      validation: { required: false },
+    },
+
+    // ==========================================================================
+    // ADMIN-ONLY FIELDS - Hidden from public, visible to admins
+    // ==========================================================================
+
+    cost: {
+      name: 'cost',
+      label: 'cost',
+      type: 'number',
+      visibility: 'admin', // Only admins see this
+      editable: 'admin',
+      validation: { required: false },
+    },
+
+    supplier: {
+      name: 'supplier',
+      label: 'supplier',
+      type: 'text',
+      visibility: 'admin',
+      editable: 'admin',
+      validation: { required: false },
+    },
+
+    // ==========================================================================
+    // STATUS FIELD - Framework provides draft/available/deleted by default
+    // ==========================================================================
+    // Add custom status options that extend framework defaults:
+
+    status: {
+      name: 'status',
+      label: 'status',
+      type: 'select',
+      visibility: 'admin',
+      validation: {
+        options: [
+          // Framework adds: draft, available, deleted
+          // Add your custom statuses:
+          { value: 'featured', label: 'status.featured' },
+          { value: 'clearance', label: 'status.clearance' },
+        ],
+      },
+    },
+  },
+});
+
+// ============================================================================
+// USAGE EXAMPLES
+// ============================================================================
+//
+// In a List Page:
+// ```tsx
+// import { EntityList } from '@donotdev/crud';
+// import { productEntity } from '../entities/ExampleEntity';
+//
+// export default function ProductsListPage() {
+//   return (
+//     <PageContainer>
+//       <EntityList entity={productEntity} />
+//     </PageContainer>
+//   );
+// }
+// ```
+//
+// In a Form Page:
+// ```tsx
+// import { EntityFormRenderer, useCrud } from '@donotdev/crud';
+// import { productEntity } from '../entities/ExampleEntity';
+//
+// export default function ProductPage() {
+//   const { get, add, update } = useCrud(productEntity);
+//   // ... see ExampleFormPage.tsx for full pattern
+// }
+// ```
+//
+// In a Card Grid:
+// ```tsx
+// import { EntityCardList } from '@donotdev/crud';
+// import { productEntity } from '../entities/ExampleEntity';
+//
+// export default function ProductsGridPage() {
+//   return (
+//     <PageContainer>
+//       <EntityCardList entity={productEntity} />
+//     </PageContainer>
+//   );
+// }
+// ```