@donotdev/cli 0.0.3 → 0.0.5

package/templates/root-consumer/guides/FEATURES.md.example

@@ -1,286 +0,0 @@
-# Using Features
-
-**Optional features with graceful degradation**
-
----
-
-## Available Features
-
-DoNotDev provides 4 optional feature packages:
-
-1. **@donotdev/auth** - Firebase Authentication
-2. **@donotdev/billing** - Stripe subscriptions
-3. **@donotdev/oauth** - OAuth providers (GitHub, Google)
-
----
-
-## Installation
-
-Install only the features you need:
-
-```bash
-# Authentication
-bun add @donotdev/auth
-
-# Billing (requires auth)
-bun add @donotdev/billing
-
-# OAuth
-bun add @donotdev/oauth
-```
-
----
-
-## Using Auth
-
-### Basic Usage
-
-```typescript
-import { useAuth } from '@donotdev/auth';
-
-export function ProfilePage() {
-  const isEnabled = useAuth('isAvailable');
-  const isLoading = useAuth('loading');
-  const user = useAuth('user');
-  const signOut = useAuth('signOut');
-
-  if (!isEnabled) {
-    return <div>Auth not available</div>;
-  }
-
-  if (isLoading) {
-    return <div>Loading...</div>;
-  }
-
-  if (!user) {
-    return <LoginPage />;
-  }
-
-  return (
-    <div>
-      <h1>Welcome, {user.displayName}!</h1>
-      <button onClick={() => signOut()}>Logout</button>
-    </div>
-  );
-}
-```
-
-### Login
-
-```typescript
-const signInWithEmail = useAuth('signInWithEmail');
-
-async function handleLogin(email: string, password: string) {
-  try {
-    await signInWithEmail(email, password);
-    // User is now authenticated
-  } catch (error) {
-    console.error('Login failed:', error);
-  }
-}
-```
-
-### Sign Up
-
-```typescript
-const signUpWithEmail = useAuth('signUpWithEmail');
-
-async function handleSignUp(email: string, password: string) {
-  try {
-    await signUpWithEmail(email, password);
-    // User account created and authenticated
-  } catch (error) {
-    console.error('Sign up failed:', error);
-  }
-}
-```
-
----
-
-## Using Billing
-
-**Requires:** `@donotdev/auth` installed
-
-### Check Subscription
-
-```typescript
-import { useStripeBilling } from '@donotdev/billing';
-
-export function UpgradePage() {
-  const isEnabled = useStripeBilling('isAvailable');
-  const subscription = useStripeBilling('subscription');
-  const checkout = useStripeBilling('checkout');
-
-  if (!isEnabled) {
-    return <div>Billing not available</div>;
-  }
-
-  return (
-    <div>
-      <h2>Current Plan: {subscription?.planId || 'Free'}</h2>
-      <button onClick={() => checkout({ priceId: 'pro', mode: 'subscription' })}>
-        Upgrade to Pro
-      </button>
-    </div>
-  );
-}
-```
-
-### Create Checkout Session
-
-```typescript
-const checkout = useStripeBilling('checkout');
-
-async function handleUpgrade() {
-  try {
-    // The checkout function handles redirecting to Stripe
-    await checkout({
-      priceId: 'pro', // The ID of the Stripe Price
-      mode: 'subscription',
-      successUrl: window.location.href, // Optional: URL to redirect on success
-      cancelUrl: window.location.origin, // Optional: URL to redirect on cancellation
-    });
-  } catch (error) {
-    console.error('Checkout failed:', error);
-  }
-}
-```
-
----
-
-## Using OAuth
-
-### GitHub OAuth
-
-```typescript
-import { useOAuth } from '@donotdev/oauth';
-
-export function ConnectGitHub() {
-  const isEnabled = useOAuth('isAvailable');
-  const signInWithGitHub = useOAuth('signInWithGitHub');
-
-  if (!isEnabled) {
-    return null;
-  }
-
-  async function handleConnect() {
-    try {
-      await signInWithGitHub();
-      // User connected to GitHub
-    } catch (error) {
-      console.error('GitHub connection failed:', error);
-    }
-  }
-
-  return (
-    <button onClick={handleConnect}>
-      Connect GitHub
-    </button>
-  );
-}
-```
-
----
-
-## Feature Detection
-
-All features export `use{Feature}()` hooks that include `isAvailable` check:
-
-```typescript
-import { useAuth } from '@donotdev/auth';
-import { useStripeBilling } from '@donotdev/billing';
-
-export function Navigation() {
-  const authIsAvailable = useAuth('isAvailable');
-  const user = useAuth('user');
-  const billingIsAvailable = useStripeBilling('isAvailable');
-
-  return (
-    <nav>
-      <Link to="/home">Home</Link>
-
-      {authIsAvailable && user && (
-        <Link to="/dashboard">Dashboard</Link>
-      )}
-
-      {billingIsAvailable && (
-        <Link to="/upgrade">Upgrade</Link>
-      )}
-    </nav>
-  );
-}
-```
-
-**Benefits:**
-
-- Features lazy-load when needed
-- Graceful degradation if not installed
-- Tree-shaking removes unused features
-
----
-
-## Configuration
-
-### Firebase (for Auth)
-
-```typescript
-// src/App.tsx
-import { ViteAppProviders } from '@donotdev/ui';
-
-<ViteAppProviders
-  firebaseConfig={{
-    apiKey: import.meta.env.VITE_FIREBASE_API_KEY,
-    authDomain: import.meta.env.VITE_FIREBASE_AUTH_DOMAIN,
-    projectId: import.meta.env.VITE_FIREBASE_PROJECT_ID,
-    // ...
-  }}
->
-  {/* Your app */}
-</ViteAppProviders>
-```
-
-### Stripe (for Billing)
-
-Set environment variables:
-
-```bash
-# .env
-VITE_STRIPE_PUBLISHABLE_KEY=pk_test_...
-```
-
----
-
-## Protected Routes
-
-Use `meta.auth.required` to protect pages:
-
-```typescript
-import type { PageMeta } from '@donotdev/core';
-
-export const meta: PageMeta = {
-  auth: { required: true },
-};
-
-export function DashboardPage() {
-  // User is guaranteed to be authenticated here
-  return <div>Dashboard</div>;
-}
-```
-
----
-
-## Best Practices
-
-- ✅ Always check `isEnabled` before using features
-- ✅ Handle loading and error states
-- ✅ Use feature detection for conditional UI
-- ✅ Set up environment variables properly
-- ❌ Don't assume features are installed
-- ❌ Don't call feature methods without checking `isEnabled`
-
----
-
-**Related:**
-
-- [INSTALLATION.md](../../INSTALLATION.md) - Installing packages
-- [docs/architecture/FEATURE_DETECTION.md](../architecture/FEATURE_DETECTION.md) - How feature detection works

package/templates/root-consumer/guides/FRAMEWORK_OVERVIEW.md.example

@@ -1,97 +0,0 @@
-# Framework Overview
-
-**DoNotDev Package Ecosystem**
-
----
-
-## Free Public Tools
-
-**`@donotdev/cli`** - Command-line tool for scaffolding, dev servers, deployment
-
-**`@donotdev/components`** - UI component library (standalone, can use anywhere)
-
-**`@donotdev/templates`** - Pre-built page templates (open to contributions)
-
----
-
-## Paid Framework Packages
-
-**Foundation:**
-
-- `@donotdev/core` - Engine (utilities, hooks, types, state management)
-- `@donotdev/ui` - Composition layer (layouts, routing, feature integration)
-
-**Features** (install what you need):
-
-- `@donotdev/auth` - Authentication & authorization
-- `@donotdev/billing` - Stripe integration
-- `@donotdev/crud` - Data operations (forms, tables)
-- `@donotdev/oauth` - Social sign-on
-
-**Backend:**
-
-- `@donotdev/firebase` - Firebase platform
-- `@donotdev/functions` - Serverless function templates (Firebase/Vercel)
-
----
-
-## Architecture
-
-```
-Your App
-├── @donotdev/ui (Layouts, Routing)
-├── @donotdev/templates (Pre-built Pages)
-├── Features (auth, billing, crud - optional)
-└── @donotdev/core (Foundation)
-```
-
-**Key:** Framework detects installed features, keeps bundle lean.
-
----
-
-## Getting Started
-
-**1. Install CLI:**
-
-```bash
-npm install -g @donotdev/cli
-```
-
-**2. Create project:**
-
-```bash
-dndev init my-app
-```
-
-**3. Add features:**
-
-```bash
-cd my-app
-npm install @donotdev/auth @donotdev/billing
-```
-
-**4. Start dev server:**
-
-```bash
-dndev dev
-```
-
----
-
-## Import Pattern
-
-Import everything from `@donotdev/core`:
-
-```typescript
-import { useAuth, useTranslation, useThemeStore } from '@donotdev/core';
-```
-
-Import UI components from `@donotdev/ui`:
-
-```typescript
-import { Button, Card } from '@donotdev/ui';
-```
-
----
-
-**Simple. Modular. Type-safe.**

package/templates/root-consumer/guides/FUNCTIONS.md.example

@@ -1,177 +0,0 @@
-# Firebase Functions Setup
-
-This guide covers Firebase Cloud Functions setup, deployment, and the critical `functions.yaml` file.
-
-## Overview
-
-Firebase Functions provide serverless backend capabilities for your DoNotDev application. Functions are scaffolded into your app's `functions/` directory and deployed to Firebase Cloud Functions.
-
-## Structure
-
-```
-functions/
-├── src/
-│   ├── auth/                    # Authentication functions
-│   ├── oauth/                   # OAuth functions
-│   ├── billing/                 # Billing functions
-│   └── index.ts                # Main functions entry point
-├── package.json                # Dependencies and scripts
-├── tsconfig.json              # TypeScript configuration
-├── functions.yaml             # Firebase function manifest (auto-generated)
-├── .env.example               # Environment variables template
-├── service-account-key.json   # Firebase service account key
-└── README.md                  # Functions documentation
-```
-
-## Critical: functions.yaml
-
-**`functions.yaml` must be manually created and maintained.** This file serves as a manifest that tells Firebase which functions to deploy and their configuration.
-
-### Important Notes
-
-1. **Manually Maintained**: You must create and maintain this file yourself
-2. **Must Include All Functions**: Every function exported from `src/index.ts` must be listed in `functions.yaml`
-3. **Deployment Dependency**: If a function is missing from `functions.yaml`, it won't be deployed
-4. **Cleared Before Build**: The deployment script clears `functions.yaml` before building, so you must recreate it with all your functions
-
-### How It Works
-
-1. **Export in `src/index.ts`**: All functions must be exported from `src/index.ts`
-   ```typescript
-   export * from './billing/createCustomerPortal.js';
-   ```
-
-2. **Create Entry in `functions.yaml`**: For each exported function, add an entry:
-   ```yaml
-   endpoints:
-     createCustomerPortal:
-       region:
-         - europe-west1
-       platform: gcfv2
-       httpsTrigger: {}
-       entryPoint: createCustomerPortal
-       labels: {}
-   ```
-
-3. **Deployment Process**: During `dndev deploy`:
-   - Functions are built to `lib/`
-   - Firebase CLI deploys functions listed in `functions.yaml`
-   - `functions.yaml` is preserved and not modified by the deployment script
-
-### Troubleshooting Missing Functions
-
-If a function isn't being deployed:
-
-1. **Check Export**: Ensure the function is exported in `src/index.ts`
-2. **Check Build**: Verify the function exists in `lib/index.js` after build
-3. **Check functions.yaml**: Verify the function is listed in `functions.yaml` with correct `entryPoint` name matching the export name
-
-### Example functions.yaml
-
-```yaml
-endpoints:
-  functionName1:
-    region:
-      - europe-west1
-    platform: gcfv2
-    httpsTrigger: {}
-    entryPoint: functionName1
-    labels: {}
-  functionName2:
-    region:
-      - europe-west1
-    platform: gcfv2
-    httpsTrigger: {}
-    entryPoint: functionName2
-    labels: {}
-specVersion: v1alpha1
-requiredAPIs: []
-```
-
-## Environment Variables
-
-Functions use a different `.env` system than Vite/Next.js:
-
-- **Local Development**: `.env.local` file (Loaded automatically by `dn emu`)
-- **Production Secrets**: `.env` file (Used by `dn sync-secrets` to update Cloud Functions)
-
-**Note:** Functions don't follow Vite/Next.js `.env.local` priority rules. We enforce a strict separation: `.env` is ONLY for production, `.env.local` is ONLY for emulators.
-
-See [EMULATOR_SETUP.md](./EMULATOR_SETUP.md) for more details.
-
-### Required Environment Variables (.env.local for development)
-
-```bash
-# Stripe Configuration
-STRIPE_SECRET_KEY=sk_test_...
-STRIPE_WEBHOOK_SECRET=whsec_...
-```
-
-## Deployment
-
-Use the unified deployment command from workspace root:
-
-```bash
-# Deploy everything (interactive)
-dndev deploy
-
-# Deploy specific app
-dndev deploy <app-name>
-```
-
-The deployment process:
-1. Clears `lib/` folder for fresh build
-2. Builds functions to `lib/`
-3. Deploys all functions listed in `functions.yaml` (manually maintained, not modified by deployment)
-
-## Development
-
-```bash
-# Start Firebase emulators
-bun run serve
-
-# Start with debugging
-bun run dev
-```
-
-## Adding New Functions
-
-1. **Create Function File**: Add your function in `src/` (e.g., `src/billing/myNewFunction.ts`)
-2. **Export in index.ts**: Add export to `src/index.ts`:
-   ```typescript
-   export * from './billing/myNewFunction.js';
-   ```
-3. **Add to functions.yaml**: Add entry to `functions.yaml`:
-   ```yaml
-   myNewFunction:
-     region:
-       - europe-west1
-     platform: gcfv2
-     httpsTrigger: {}
-     entryPoint: myNewFunction
-     labels: {}
-   ```
-4. **Deploy**: Run `dndev deploy` - the function will be deployed if listed in `functions.yaml`
-
-## Security
-
-- All functions require authentication
-- Webhook signature verification
-- Secure token management
-- Firebase custom claims for user status
-
-## Framework Integration
-
-Functions use the framework's `@donotdev/functions` package:
-
-```typescript
-// apps/your-app/functions/src/billing/createCheckoutSession.ts
-import { createCheckoutSession as generic } from '@donotdev/functions/firebase';
-import { stripeBackConfig } from '../config/stripeBackConfig';
-
-// Your app's function = framework + your config
-export const createCheckoutSession = generic(stripeBackConfig);
-```
-
-See [Functions Package Architecture](../../../docs/architecture/packages/FUNCTIONS_PACKAGE.md) for detailed explanation.
-