@khester/create-dynamics-app 1.0.8 → 1.1.0

package/templates/dynamics-365-starter/src/client-project-template/scripts/client-setup.js

@@ -0,0 +1,667 @@
+#!/usr/bin/env node
+
+/**
+ * Client Project Setup Script
+ * Automates the setup of client-specific configurations and branding
+ */
+
+const fs = require('fs-extra');
+const path = require('path');
+const inquirer = require('inquirer');
+const chalk = require('chalk');
+
+async function setupClientProject() {
+  console.log(chalk.cyan('\n🎯 Client Project Setup\n'));
+  
+  // Gather client information
+  const answers = await inquirer.prompt([
+    {
+      type: 'input',
+      name: 'clientName',
+      message: 'Client full name:',
+      validate: input => input.length > 0
+    },
+    {
+      type: 'input',
+      name: 'clientCode',
+      message: 'Client code (3-4 characters):',
+      validate: input => input.length >= 3 && input.length <= 4
+    },
+    {
+      type: 'list',
+      name: 'industry',
+      message: 'Industry:',
+      choices: [
+        'Manufacturing',
+        'Healthcare',
+        'Financial Services',
+        'Retail',
+        'Technology',
+        'Education',
+        'Government',
+        'Non-Profit',
+        'Other'
+      ]
+    },
+    {
+      type: 'list',
+      name: 'timezone',
+      message: 'Primary timezone:',
+      choices: [
+        'America/New_York',
+        'America/Chicago',
+        'America/Denver',
+        'America/Los_Angeles',
+        'Europe/London',
+        'Europe/Paris',
+        'Asia/Tokyo',
+        'Australia/Sydney'
+      ]
+    },
+    {
+      type: 'input',
+      name: 'primaryContact',
+      message: 'Primary contact name:'
+    },
+    {
+      type: 'input',
+      name: 'contactEmail',
+      message: 'Primary contact email:',
+      validate: input => /\S+@\S+\.\S+/.test(input)
+    },
+    {
+      type: 'input',
+      name: 'primaryColor',
+      message: 'Primary brand color (hex):',
+      default: '#0078d4'
+    },
+    {
+      type: 'input',
+      name: 'secondaryColor',
+      message: 'Secondary brand color (hex):',
+      default: '#106ebe'
+    },
+    {
+      type: 'checkbox',
+      name: 'environments',
+      message: 'Environments to configure:',
+      choices: [
+        { name: 'Development', value: 'dev', checked: true },
+        { name: 'Testing', value: 'test', checked: true },
+        { name: 'Staging', value: 'staging', checked: false },
+        { name: 'Production', value: 'prod', checked: true }
+      ]
+    },
+    {
+      type: 'confirm',
+      name: 'enableAdvancedFeatures',
+      message: 'Enable advanced features (custom workflows, reporting, etc.)?',
+      default: true
+    }
+  ]);
+
+  console.log(chalk.cyan('\n📁 Creating client configuration...\n'));
+
+  // Create client configuration
+  await createClientConfig(answers);
+
+  // Create environment configurations
+  for (const env of answers.environments) {
+    await createEnvironmentConfig(env, answers);
+  }
+
+  // Create branding files
+  await createBrandingFiles(answers);
+
+  // Create deployment scripts
+  await createDeploymentScripts(answers);
+
+  // Create documentation
+  await createProjectDocumentation(answers);
+
+  console.log(chalk.green('\n✅ Client project setup completed!\n'));
+  console.log(chalk.cyan('📝 Next steps:'));
+  console.log('   1. Review and update configuration files');
+  console.log('   2. Add client logos to src/branding/logos/');
+  console.log('   3. Configure environment-specific settings');
+  console.log('   4. Set up deployment pipelines');
+  console.log('   5. Run initial deployment to dev environment');
+  console.log('\n📚 Documentation created in docs/ folder');
+}
+
+async function createClientConfig(answers) {
+  const configPath = 'config/client.json';
+  await fs.ensureDir(path.dirname(configPath));
+
+  const clientConfig = {
+    name: answers.clientName,
+    code: answers.clientCode.toUpperCase(),
+    industry: answers.industry,
+    timezone: answers.timezone,
+    locale: 'en-US',
+    version: '1.0.0',
+    created: new Date().toISOString(),
+    lastUpdated: new Date().toISOString(),
+    contact: {
+      primaryContact: answers.primaryContact,
+      email: answers.contactEmail,
+      phone: ''
+    },
+    branding: {
+      primaryColor: answers.primaryColor,
+      secondaryColor: answers.secondaryColor,
+      accentColor: '#ffaa44',
+      logoPath: `src/branding/logos/${answers.clientCode.toLowerCase()}-logo.png`,
+      faviconPath: `src/branding/logos/${answers.clientCode.toLowerCase()}-favicon.ico`,
+      fontFamily: 'Segoe UI, sans-serif',
+      customCss: `src/branding/${answers.clientCode.toLowerCase()}-custom.css`
+    },
+    features: {
+      enableAdvancedLogging: answers.enableAdvancedFeatures,
+      enableCustomWorkflows: answers.enableAdvancedFeatures,
+      enableReporting: answers.enableAdvancedFeatures,
+      enableMobileOptimization: true,
+      enableOfflineCapability: false,
+      enableMultiLanguage: false,
+      enableCustomDashboards: answers.enableAdvancedFeatures,
+      enableDataExport: true,
+      enableBulkOperations: true,
+      enableAdvancedSecurity: true
+    },
+    customEntities: [],
+    integrations: {
+      sharepoint: { enabled: false, siteUrl: '' },
+      teams: { enabled: false, appId: '' },
+      powerBI: { enabled: false, workspaceId: '' },
+      powerAutomate: { enabled: true },
+      externalAPIs: []
+    },
+    compliance: {
+      gdprCompliant: true,
+      hipaaCompliant: false,
+      soxCompliant: false,
+      auditRetentionDays: 365,
+      dataClassification: 'Internal'
+    },
+    deployment: {
+      strategy: 'blue-green',
+      rollbackEnabled: true,
+      approvalRequired: true,
+      notificationEmail: answers.contactEmail,
+      maintenanceWindow: {
+        timezone: answers.timezone,
+        startTime: '02:00',
+        duration: 120
+      }
+    }
+  };
+
+  await fs.writeJson(configPath, clientConfig, { spaces: 2 });
+  console.log(chalk.green(`   ✓ Created ${configPath}`));
+}
+
+async function createEnvironmentConfig(environment, answers) {
+  const envPath = `config/environments/${environment}.json`;
+  await fs.ensureDir(path.dirname(envPath));
+
+  const environmentConfig = {
+    name: environment.charAt(0).toUpperCase() + environment.slice(1),
+    type: environment,
+    description: `${environment.charAt(0).toUpperCase() + environment.slice(1)} environment for ${answers.clientName}`,
+    lastUpdated: new Date().toISOString(),
+    dynamics365: {
+      orgUrl: `https://${answers.clientCode.toLowerCase()}-${environment}.crm.dynamics.com`,
+      webApiUrl: `https://${answers.clientCode.toLowerCase()}-${environment}.api.crm.dynamics.com/api/data/v9.2`,
+      version: '9.2',
+      region: 'northamerica',
+      tenantId: 'your-tenant-id',
+      dataverse: {
+        environmentId: 'your-environment-id',
+        uniqueName: `${answers.clientCode.toLowerCase()}-${environment}`
+      }
+    },
+    authentication: {
+      type: 'oauth2',
+      clientId: 'your-client-id',
+      clientSecret: 'your-client-secret',
+      redirectUri: `https://${answers.clientCode.toLowerCase()}-${environment}.dynamics.com/auth/callback`,
+      scopes: [`https://${answers.clientCode.toLowerCase()}-${environment}.crm.dynamics.com/user_impersonation`],
+      authority: 'https://login.microsoftonline.com/your-tenant-id'
+    },
+    security: {
+      enableAuditLogging: true,
+      requireMFA: environment === 'prod',
+      sessionTimeout: environment === 'prod' ? 480 : 720,
+      enableConditionalAccess: environment === 'prod',
+      allowedIPs: [],
+      dataLossPreventionEnabled: environment === 'prod',
+      encryptionAtRest: true,
+      encryptionInTransit: true
+    },
+    performance: {
+      enableCaching: environment !== 'dev',
+      cacheTimeout: 300,
+      batchSize: environment === 'prod' ? 100 : 50,
+      timeoutMs: 30000,
+      retryAttempts: 3,
+      retryDelayMs: 1000,
+      enableCompression: true,
+      enableCDN: environment === 'prod'
+    },
+    monitoring: {
+      enableApplicationInsights: true,
+      instrumentationKey: 'your-instrumentation-key',
+      logLevel: environment === 'prod' ? 'error' : environment === 'test' ? 'warn' : 'debug',
+      enableMetrics: true,
+      enableTracing: environment !== 'prod',
+      enableProfiling: environment === 'dev'
+    }
+  };
+
+  await fs.writeJson(envPath, environmentConfig, { spaces: 2 });
+  console.log(chalk.green(`   ✓ Created ${envPath}`));
+}
+
+async function createBrandingFiles(answers) {
+  const brandingPath = 'src/branding';
+  await fs.ensureDir(brandingPath);
+  await fs.ensureDir(path.join(brandingPath, 'logos'));
+
+  // Create theme file
+  const themeContent = `// ${answers.clientName} Theme Configuration
+import { ITheme } from '@fluentui/react';
+
+export const ${answers.clientCode.toLowerCase()}Theme: ITheme = {
+  palette: {
+    themePrimary: '${answers.primaryColor}',
+    themeSecondary: '${answers.secondaryColor}',
+    themeTertiary: '#71afe5',
+    themeLight: '#c7e0f4',
+    themeLighter: '#deecf9',
+    themeLighterAlt: '#eff6fc',
+    black: '#000000',
+    blackTranslucent40: 'rgba(0,0,0,.4)',
+    neutralDark: '#201f1e',
+    neutralPrimary: '#323130',
+    neutralPrimaryAlt: '#3b3a39',
+    neutralSecondary: '#605e5c',
+    neutralTertiary: '#a19f9d',
+    neutralTertiaryAlt: '#c8c6c4',
+    neutralQuaternary: '#d2d0ce',
+    neutralQuaternaryAlt: '#e1dfdd',
+    neutralLight: '#edebe9',
+    neutralLighter: '#f3f2f1',
+    neutralLighterAlt: '#faf9f8',
+    white: '#ffffff',
+    yellowDark: '#d29200',
+    yellow: '#ffb900',
+    yellowLight: '#fff4ce',
+    orange: '#d83b01',
+    orangeLight: '#febf04',
+    orangeLighter: '#fcd116',
+    redDark: '#a4262c',
+    red: '#e81123',
+    magentaDark: '#5c2d91',
+    magenta: '#b4009e',
+    magentaLight: '#e3008c',
+    purpleDark: '#32145a',
+    purple: '#5c2d91',
+    purpleLight: '#b4a0ff',
+    blueDark: '#002050',
+    blueMid: '#00188f',
+    blue: '${answers.primaryColor}',
+    blueLight: '#40e0d0',
+    tealDark: '#004b50',
+    teal: '#008272',
+    tealLight: '#00bcf2',
+    greenDark: '#004b1c',
+    green: '#107c10',
+    greenLight: '#bad80a'
+  },
+  fonts: {
+    small: {
+      fontSize: '12px',
+      lineHeight: '16px'
+    },
+    medium: {
+      fontSize: '14px',
+      lineHeight: '20px',
+      fontFamily: 'Segoe UI, sans-serif'
+    },
+    large: {
+      fontSize: '18px',
+      lineHeight: '24px'
+    },
+    xLarge: {
+      fontSize: '20px',
+      lineHeight: '28px'
+    },
+    xxLarge: {
+      fontSize: '28px',
+      lineHeight: '36px'
+    }
+  }
+};`;
+
+  await fs.writeFile(path.join(brandingPath, 'theme.ts'), themeContent);
+
+  // Create custom CSS file
+  const customCssContent = `/* ${answers.clientName} Custom Styles */
+
+:root {
+  --client-primary-color: ${answers.primaryColor};
+  --client-secondary-color: ${answers.secondaryColor};
+  --client-font-family: 'Segoe UI', sans-serif;
+}
+
+/* Client-specific component overrides */
+.client-header {
+  background-color: var(--client-primary-color);
+  color: white;
+}
+
+.client-navigation {
+  border-bottom: 2px solid var(--client-primary-color);
+}
+
+.client-button-primary {
+  background-color: var(--client-primary-color);
+  border-color: var(--client-primary-color);
+}
+
+.client-button-primary:hover {
+  background-color: var(--client-secondary-color);
+  border-color: var(--client-secondary-color);
+}
+
+/* Logo and branding */
+.client-logo {
+  max-height: 40px;
+  width: auto;
+}
+
+/* Custom responsive breakpoints for client */
+@media (max-width: 768px) {
+  .client-header {
+    padding: 10px;
+  }
+}`;
+
+  await fs.writeFile(path.join(brandingPath, `${answers.clientCode.toLowerCase()}-custom.css`), customCssContent);
+
+  // Create logo placeholder README
+  const logoReadme = `# ${answers.clientName} Logos
+
+Please add the following logo files to this directory:
+
+- \`${answers.clientCode.toLowerCase()}-logo.png\` - Main logo (recommended: 200x60px)
+- \`${answers.clientCode.toLowerCase()}-logo-white.png\` - White version for dark backgrounds
+- \`${answers.clientCode.toLowerCase()}-favicon.ico\` - Favicon (16x16, 32x32px)
+- \`${answers.clientCode.toLowerCase()}-logo-large.png\` - High resolution logo (400x120px)
+
+## Logo Guidelines
+
+- Use PNG format with transparent background
+- Maintain aspect ratio when resizing
+- Ensure logos are optimized for web use
+- Test visibility on both light and dark backgrounds
+`;
+
+  await fs.writeFile(path.join(brandingPath, 'logos', 'README.md'), logoReadme);
+
+  console.log(chalk.green(`   ✓ Created branding files in ${brandingPath}/`));
+}
+
+async function createDeploymentScripts(answers) {
+  const scriptsPath = 'scripts';
+  await fs.ensureDir(scriptsPath);
+
+  // Client-specific deployment script
+  const deployScript = `#!/bin/bash
+# ${answers.clientName} Deployment Script
+# Generated on ${new Date().toISOString()}
+
+CLIENT_NAME="${answers.clientName}"
+CLIENT_CODE="${answers.clientCode.toUpperCase()}"
+PROJECT_ROOT="$(cd "$(dirname "\${BASH_SOURCE[0]}")/.." && pwd)"
+
+echo "🚀 Deploying \${CLIENT_NAME} project..."
+
+# Validate environment parameter
+if [ -z "$1" ]; then
+  echo "❌ Environment parameter required"
+  echo "Usage: $0 <environment>"
+  echo "Available environments: dev, test, staging, prod"
+  exit 1
+fi
+
+ENVIRONMENT=$1
+
+# Check if environment config exists
+if [ ! -f "\${PROJECT_ROOT}/config/environments/\${ENVIRONMENT}.json" ]; then
+  echo "❌ Environment configuration not found: \${ENVIRONMENT}.json"
+  exit 1
+fi
+
+echo "📋 Deploying to \${ENVIRONMENT} environment for \${CLIENT_NAME}..."
+
+# Load environment configuration
+export NODE_ENV=\${ENVIRONMENT}
+
+# Run pre-deployment checks
+echo "🔍 Running pre-deployment checks..."
+npm run quality
+if [ $? -ne 0 ]; then
+  echo "❌ Quality checks failed"
+  exit 1
+fi
+
+# Build for target environment
+echo "🔨 Building for \${ENVIRONMENT}..."
+npm run build:prod
+if [ $? -ne 0 ]; then
+  echo "❌ Build failed"
+  exit 1
+fi
+
+# Run deployment
+echo "📦 Deploying to \${ENVIRONMENT}..."
+case \${ENVIRONMENT} in
+  "dev")
+    echo "🛠️  Deploying to development environment..."
+    # Add dev-specific deployment steps
+    ;;
+  "test")
+    echo "🧪 Deploying to test environment..."
+    # Add test-specific deployment steps
+    ;;
+  "prod")
+    echo "🚀 Deploying to production environment..."
+    # Add production-specific deployment steps
+    echo "⚠️  Production deployment requires manual approval"
+    ;;
+  *)
+    echo "❌ Unknown environment: \${ENVIRONMENT}"
+    exit 1
+    ;;
+esac
+
+echo "✅ Deployment completed for \${CLIENT_NAME} - \${ENVIRONMENT}"
+echo "📝 Next steps:"
+echo "   1. Verify deployment in Dynamics 365"
+echo "   2. Run smoke tests"
+echo "   3. Notify stakeholders"
+`;
+
+  await fs.writeFile(path.join(scriptsPath, 'deploy-client.sh'), deployScript);
+  await fs.chmod(path.join(scriptsPath, 'deploy-client.sh'), '755');
+
+  console.log(chalk.green(`   ✓ Created deployment scripts in ${scriptsPath}/`));
+}
+
+async function createProjectDocumentation(answers) {
+  const docsPath = 'docs';
+  await fs.ensureDir(docsPath);
+
+  // Client requirements document
+  const requirementsDoc = `# ${answers.clientName} - Technical Requirements
+
+**Project:** ${answers.clientName} Dynamics 365 Implementation  
+**Industry:** ${answers.industry}  
+**Primary Contact:** ${answers.primaryContact} (${answers.contactEmail})  
+**Created:** ${new Date().toLocaleDateString()}
+
+## Overview
+
+This document outlines the technical requirements and specifications for the ${answers.clientName} Dynamics 365 implementation.
+
+## Client Information
+
+- **Company:** ${answers.clientName}
+- **Industry:** ${answers.industry}
+- **Timezone:** ${answers.timezone}
+- **Primary Contact:** ${answers.primaryContact}
+- **Email:** ${answers.contactEmail}
+
+## Technical Requirements
+
+### Environments
+${answers.environments.map(env => `- ${env.charAt(0).toUpperCase() + env.slice(1)}`).join('\n')}
+
+### Branding Requirements
+- **Primary Color:** ${answers.primaryColor}
+- **Secondary Color:** ${answers.secondaryColor}
+- **Logo Requirements:** See branding guidelines
+
+### Features
+${answers.enableAdvancedFeatures ? `- Advanced logging and monitoring
+- Custom workflows and business logic
+- Enhanced reporting and dashboards
+- Mobile optimization` : `- Standard CRM functionality
+- Basic reporting
+- Mobile responsive design`}
+
+## Security Requirements
+
+- Multi-factor authentication for production
+- Data encryption at rest and in transit
+- Audit logging enabled
+- Role-based access control
+
+## Compliance Requirements
+
+- GDPR compliance required
+- Data retention: 365 days
+- Regular security assessments
+
+## Integration Requirements
+
+TBD - To be defined based on client needs
+
+## Deployment Strategy
+
+- Blue-green deployment for production
+- Automated rollback capability
+- Maintenance window: 2:00 AM ${answers.timezone}
+
+## Support Requirements
+
+- Business hours support during implementation
+- Post-go-live support plan TBD
+
+## Success Criteria
+
+TBD - To be defined with client stakeholders
+
+## Next Steps
+
+1. Review and approve requirements
+2. Define detailed functional specifications
+3. Create project timeline
+4. Begin development sprint planning
+`;
+
+  await fs.writeFile(path.join(docsPath, 'client-requirements.md'), requirementsDoc);
+
+  // Project README
+  const projectReadme = `# ${answers.clientName} - Dynamics 365 Project
+
+${answers.industry} company Dynamics 365 implementation using the Dynamics UI Kit enterprise consulting framework.
+
+## Quick Start
+
+\`\`\`bash
+# Install dependencies
+npm install
+
+# Start development
+npm run dev
+
+# Build for production
+npm run build:prod
+
+# Deploy to environment
+./scripts/deploy-client.sh dev
+\`\`\`
+
+## Project Structure
+
+- \`config/\` - Client and environment configurations
+- \`src/branding/\` - Client-specific branding and themes
+- \`src/entities/\` - Custom entity definitions
+- \`src/pages/\` - Custom page templates
+- \`scripts/\` - Deployment and automation scripts
+- \`docs/\` - Project documentation
+
+## Configuration
+
+Client configuration is managed in \`config/client.json\`. Environment-specific settings are in \`config/environments/\`.
+
+## Branding
+
+Client branding assets should be placed in \`src/branding/logos/\`. The theme is configured in \`src/branding/theme.ts\`.
+
+## Deployment
+
+Use the deployment script for environment-specific deployments:
+
+\`\`\`bash
+# Deploy to development
+./scripts/deploy-client.sh dev
+
+# Deploy to production (requires approval)
+./scripts/deploy-client.sh prod
+\`\`\`
+
+## Development Workflow
+
+1. Create feature branch
+2. Implement changes
+3. Run quality checks: \`npm run quality\`
+4. Deploy to dev: \`./scripts/deploy-client.sh dev\`
+5. Test and get approval
+6. Deploy to production
+
+## Support
+
+For technical issues, contact the development team.  
+For client-specific questions, contact ${answers.primaryContact} at ${answers.contactEmail}.
+
+## Documentation
+
+- [Client Requirements](docs/client-requirements.md)
+- [Technical Specifications](docs/technical-specifications.md)
+- [Deployment Guide](docs/deployment-guide.md)
+`;
+
+  await fs.writeFile('README.md', projectReadme);
+
+  console.log(chalk.green(`   ✓ Created project documentation in ${docsPath}/`));
+}
+
+// Run the setup if called directly
+if (require.main === module) {
+  setupClientProject().catch(console.error);
+}
+
+module.exports = { setupClientProject };