@khester/create-dynamics-app 1.1.0 → 2.1.0

package/templates/dynamics-365-starter/src/client-project-template/README.md

@@ -1,234 +0,0 @@
-# Client Project Architecture Template
-
-This template provides a standardized structure for multi-client Dynamics 365 consulting projects.
-
-## Directory Structure
-
-```
-client-project/
-├── config/
-│   ├── client.json                 # Client-specific configuration
-│   ├── environments/               # Environment configurations
-│   │   ├── dev.json
-│   │   ├── test.json
-│   │   └── prod.json
-│   └── deployment.json             # Deployment settings
-├── src/
-│   ├── branding/                   # Client-specific branding
-│   │   ├── theme.ts               # Theme customization
-│   │   ├── logos/                 # Client logos and assets
-│   │   └── styles.css             # Client-specific styles
-│   ├── entities/                   # Client entity definitions
-│   │   ├── custom/                # Custom entities
-│   │   └── extensions/            # Standard entity extensions
-│   ├── workflows/                  # Business logic workflows
-│   ├── integrations/              # External system integrations
-│   └── reports/                   # Custom reports and dashboards
-├── deployment/
-│   ├── scripts/                   # Deployment automation
-│   ├── solutions/                 # Dynamics 365 solutions
-│   └── documentation/             # Deployment guides
-└── docs/
-    ├── client-requirements.md     # Client-specific requirements
-    ├── technical-specifications.md
-    └── user-guides/
-```
-
-## Configuration Files
-
-### client.json
-```json
-{
-  "name": "Client Name",
-  "code": "CLI",
-  "industry": "Manufacturing",
-  "timezone": "America/New_York",
-  "locale": "en-US",
-  "branding": {
-    "primaryColor": "#0078d4",
-    "secondaryColor": "#106ebe",
-    "logoPath": "src/branding/logos/client-logo.png"
-  },
-  "features": {
-    "enableAdvancedLogging": true,
-    "enableCustomWorkflows": true,
-    "enableReporting": true
-  }
-}
-```
-
-### environments/prod.json
-```json
-{
-  "name": "Production",
-  "dynamics365Url": "https://client.crm.dynamics.com",
-  "webApiUrl": "https://client.api.crm.dynamics.com/api/data/v9.2",
-  "tenantId": "client-tenant-id",
-  "clientId": "client-app-id",
-  "security": {
-    "enableAuditLogging": true,
-    "requireMFA": true,
-    "sessionTimeout": 480
-  },
-  "performance": {
-    "enableCaching": true,
-    "batchSize": 100,
-    "timeoutMs": 30000
-  }
-}
-```
-
-## Usage
-
-1. **Initialize Client Project**:
-   ```bash
-   create-dynamics-app my-client-project --client-name "ACME Corp" --entities "opportunity,quote,invoice"
-   ```
-
-2. **Configure Client Settings**:
-   - Update `config/client.json` with client details
-   - Customize branding in `src/branding/`
-   - Configure environments in `config/environments/`
-
-3. **Generate Custom Entities**:
-   ```bash
-   npm run generate:entity -- --entity customopportunity --display-name "Custom Opportunity"
-   ```
-
-4. **Deploy to Environment**:
-   ```bash
-   npm run deploy:prod
-   ```
-
-## Best Practices
-
-### Multi-Tenant Considerations
-- Use environment-specific configurations
-- Implement client-specific theming
-- Maintain separate deployment pipelines
-- Use feature flags for client-specific functionality
-
-### Security
-- Store sensitive configuration in Azure Key Vault
-- Use managed identities for authentication
-- Implement proper access controls
-- Enable audit logging
-
-### Development Workflow
-1. Create feature branch for client customization
-2. Implement and test changes
-3. Run quality checks: `npm run quality`
-4. Deploy to test environment
-5. Get client approval
-6. Deploy to production
-
-### Code Organization
-- Keep client-specific code in dedicated directories
-- Use dependency injection for client configurations
-- Implement factory patterns for environment-specific services
-- Document all customizations
-
-## Deployment
-
-### Automated Deployment
-The template includes scripts for automated deployment:
-
-```bash
-# Deploy to specific environment
-./scripts/deploy.sh dev
-./scripts/deploy.sh test
-./scripts/deploy.sh prod
-
-# Deploy with client validation
-./scripts/deploy-client.sh --client ACME --env prod
-```
-
-### Manual Deployment Checklist
-- [ ] Update client configuration
-- [ ] Build and test locally
-- [ ] Deploy to test environment
-- [ ] Run smoke tests
-- [ ] Get client sign-off
-- [ ] Deploy to production
-- [ ] Verify deployment
-- [ ] Update documentation
-
-## Customization Examples
-
-### Client Theming
-```typescript
-// src/branding/theme.ts
-export const clientTheme = {
-  palette: {
-    themePrimary: '#0078d4',
-    themeSecondary: '#106ebe',
-    neutralPrimary: '#323130'
-  },
-  fonts: {
-    medium: {
-      fontFamily: 'Client Corporate Font, Segoe UI, sans-serif'
-    }
-  }
-};
-```
-
-### Custom Entity Extensions
-```typescript
-// src/entities/extensions/OpportunityExtensions.ts
-export class ClientOpportunity extends Opportunity {
-  public customField1: string = '';
-  public customField2: number = 0;
-  
-  public validateClientSpecificRules(): ValidationResult {
-    // Client-specific validation logic
-  }
-}
-```
-
-### Environment-Specific Services
-```typescript
-// src/services/ClientServiceFactory.ts
-export class ClientServiceFactory {
-  public static createApiService(environment: string): IApiService {
-    const config = getEnvironmentConfig(environment);
-    
-    if (config.enableMockServices) {
-      return new MockApiService();
-    } else {
-      return new XrmApiService(config);
-    }
-  }
-}
-```
-
-## Maintenance
-
-### Regular Tasks
-- Update client configurations as requirements change
-- Monitor deployment success rates
-- Review and update documentation
-- Conduct security audits
-- Performance monitoring and optimization
-
-### Upgrade Path
-1. Test new framework versions in dev environment
-2. Update client projects incrementally
-3. Maintain backward compatibility
-4. Document breaking changes
-5. Coordinate client upgrade schedules
-
-## Support
-
-For client project support:
-1. Check project documentation in `docs/`
-2. Review deployment logs
-3. Contact development team with client context
-4. Escalate to client success team if needed
-
-## Templates Available
-
-- **Standard CRM**: Contact, Account, Opportunity management
-- **Sales Pipeline**: Quote, Order, Invoice workflow
-- **Service Management**: Case, Knowledge base, SLA tracking
-- **Project Management**: Project, Task, Resource allocation
-- **Custom Industry**: Tailored for specific industry needs

package/templates/dynamics-365-starter/src/client-project-template/config/client.template.json

@@ -1,114 +0,0 @@
-{
-  "name": "{{clientName}}",
-  "code": "{{clientCode}}",
-  "industry": "{{industry}}",
-  "timezone": "{{timezone}}",
-  "locale": "{{locale}}",
-  "version": "1.0.0",
-  "created": "{{currentDate}}",
-  "lastUpdated": "{{currentDate}}",
-  "contact": {
-    "primaryContact": "{{primaryContact}}",
-    "email": "{{contactEmail}}",
-    "phone": "{{contactPhone}}"
-  },
-  "branding": {
-    "primaryColor": "{{primaryColor}}",
-    "secondaryColor": "{{secondaryColor}}",
-    "accentColor": "{{accentColor}}",
-    "logoPath": "src/branding/logos/{{clientCode}}-logo.png",
-    "faviconPath": "src/branding/logos/{{clientCode}}-favicon.ico",
-    "fontFamily": "{{fontFamily}}",
-    "customCss": "src/branding/{{clientCode}}-custom.css"
-  },
-  "features": {
-    "enableAdvancedLogging": true,
-    "enableCustomWorkflows": true,
-    "enableReporting": true,
-    "enableMobileOptimization": true,
-    "enableOfflineCapability": false,
-    "enableMultiLanguage": false,
-    "enableCustomDashboards": true,
-    "enableDataExport": true,
-    "enableBulkOperations": true,
-    "enableAdvancedSecurity": true
-  },
-  "customEntities": [
-    {{#each customEntities}}
-    {
-      "name": "{{name}}",
-      "displayName": "{{displayName}}",
-      "description": "{{description}}",
-      "enabled": true
-    }{{#unless @last}},{{/unless}}
-    {{/each}}
-  ],
-  "integrations": {
-    "sharepoint": {
-      "enabled": false,
-      "siteUrl": ""
-    },
-    "teams": {
-      "enabled": false,
-      "appId": ""
-    },
-    "powerBI": {
-      "enabled": false,
-      "workspaceId": ""
-    },
-    "powerAutomate": {
-      "enabled": true
-    },
-    "externalAPIs": [
-      {{#each externalAPIs}}
-      {
-        "name": "{{name}}",
-        "endpoint": "{{endpoint}}",
-        "authType": "{{authType}}",
-        "enabled": {{enabled}}
-      }{{#unless @last}},{{/unless}}
-      {{/each}}
-    ]
-  },
-  "compliance": {
-    "gdprCompliant": true,
-    "hipaaCompliant": false,
-    "soxCompliant": false,
-    "auditRetentionDays": 365,
-    "dataClassification": "Internal"
-  },
-  "deployment": {
-    "strategy": "blue-green",
-    "rollbackEnabled": true,
-    "approvalRequired": true,
-    "notificationEmail": "{{contactEmail}}",
-    "maintenanceWindow": {
-      "timezone": "{{timezone}}",
-      "startTime": "02:00",
-      "duration": 120
-    }
-  },
-  "support": {
-    "level": "Enterprise",
-    "hours": "24/7",
-    "escalationEmail": "{{supportEmail}}",
-    "slaTier": "Gold"
-  },
-  "customizations": {
-    "entities": {
-      "naming": "{{clientCode}}_",
-      "prefix": "{{clientCode}}",
-      "suffix": ""
-    },
-    "workflows": {
-      "customValidation": true,
-      "customBusinessLogic": true,
-      "customIntegrations": true
-    },
-    "ui": {
-      "customTheme": true,
-      "customComponents": true,
-      "customLayouts": true
-    }
-  }
-}

package/templates/dynamics-365-starter/src/client-project-template/config/environments/template.json

@@ -1,186 +0,0 @@
-{
-  "name": "{{environmentName}}",
-  "type": "{{environmentType}}",
-  "description": "{{environmentDescription}}",
-  "lastUpdated": "{{currentDate}}",
-  "dynamics365": {
-    "orgUrl": "{{orgUrl}}",
-    "webApiUrl": "{{webApiUrl}}",
-    "version": "9.2",
-    "region": "{{region}}",
-    "tenantId": "{{tenantId}}",
-    "dataverse": {
-      "environmentId": "{{environmentId}}",
-      "uniqueName": "{{uniqueName}}"
-    }
-  },
-  "authentication": {
-    "type": "{{authType}}",
-    "clientId": "{{clientId}}",
-    "clientSecret": "{{clientSecret}}",
-    "redirectUri": "{{redirectUri}}",
-    "scopes": [
-      "https://{{orgDomain}}.crm.dynamics.com/user_impersonation"
-    ],
-    "authority": "https://login.microsoftonline.com/{{tenantId}}"
-  },
-  "security": {
-    "enableAuditLogging": true,
-    "requireMFA": "{{requireMFA}}",
-    "sessionTimeout": {{sessionTimeout}},
-    "enableConditionalAccess": true,
-    "allowedIPs": [
-      {{#each allowedIPs}}
-      "{{this}}"{{#unless @last}},{{/unless}}
-      {{/each}}
-    ],
-    "dataLossPreventionEnabled": true,
-    "encryptionAtRest": true,
-    "encryptionInTransit": true
-  },
-  "performance": {
-    "enableCaching": {{enableCaching}},
-    "cacheTimeout": {{cacheTimeout}},
-    "batchSize": {{batchSize}},
-    "timeoutMs": {{timeoutMs}},
-    "retryAttempts": {{retryAttempts}},
-    "retryDelayMs": {{retryDelayMs}},
-    "enableCompression": true,
-    "enableCDN": {{enableCDN}}
-  },
-  "monitoring": {
-    "enableApplicationInsights": true,
-    "instrumentationKey": "{{instrumentationKey}}",
-    "logLevel": "{{logLevel}}",
-    "enableMetrics": true,
-    "enableTracing": true,
-    "enableProfiling": false,
-    "alertRules": [
-      {
-        "name": "High Error Rate",
-        "condition": "exceptions/hour > 10",
-        "severity": "Critical",
-        "enabled": true
-      },
-      {
-        "name": "Slow Response Time",
-        "condition": "avg(requests/duration) > 5000",
-        "severity": "Warning",
-        "enabled": true
-      }
-    ]
-  },
-  "backup": {
-    "enabled": {{backupEnabled}},
-    "frequency": "{{backupFrequency}}",
-    "retentionDays": {{backupRetentionDays}},
-    "storageAccount": "{{backupStorageAccount}}",
-    "enablePointInTimeRestore": {{enablePointInTimeRestore}}
-  },
-  "networking": {
-    "enableVNet": {{enableVNet}},
-    "subnetId": "{{subnetId}}",
-    "enablePrivateEndpoint": {{enablePrivateEndpoint}},
-    "enableServiceEndpoint": {{enableServiceEndpoint}},
-    "firewallRules": [
-      {{#each firewallRules}}
-      {
-        "name": "{{name}}",
-        "startIP": "{{startIP}}",
-        "endIP": "{{endIP}}",
-        "enabled": {{enabled}}
-      }{{#unless @last}},{{/unless}}
-      {{/each}}
-    ]
-  },
-  "deployment": {
-    "strategy": "{{deploymentStrategy}}",
-    "slots": [
-      {{#each deploymentSlots}}
-      {
-        "name": "{{name}}",
-        "enabled": {{enabled}},
-        "percentage": {{percentage}}
-      }{{#unless @last}},{{/unless}}
-      {{/each}}
-    ],
-    "rollbackEnabled": {{rollbackEnabled}},
-    "healthCheckUrl": "{{healthCheckUrl}}",
-    "warmupEnabled": {{warmupEnabled}},
-    "preDeploymentSteps": [
-      {{#each preDeploymentSteps}}
-      "{{this}}"{{#unless @last}},{{/unless}}
-      {{/each}}
-    ],
-    "postDeploymentSteps": [
-      {{#each postDeploymentSteps}}
-      "{{this}}"{{#unless @last}},{{/unless}}
-      {{/each}}
-    ]
-  },
-  "integrations": {
-    "keyVault": {
-      "enabled": {{keyVaultEnabled}},
-      "vaultUrl": "{{keyVaultUrl}}",
-      "secrets": [
-        {{#each keyVaultSecrets}}
-        "{{this}}"{{#unless @last}},{{/unless}}
-        {{/each}}
-      ]
-    },
-    "servicebus": {
-      "enabled": {{serviceBusEnabled}},
-      "connectionString": "{{serviceBusConnectionString}}",
-      "queues": [
-        {{#each serviceBusQueues}}
-        "{{this}}"{{#unless @last}},{{/unless}}
-        {{/each}}
-      ]
-    },
-    "storage": {
-      "enabled": {{storageEnabled}},
-      "accountName": "{{storageAccountName}}",
-      "containerName": "{{storageContainerName}}",
-      "enableStaticWebsite": {{enableStaticWebsite}}
-    }
-  },
-  "customSettings": {
-    {{#each customSettings}}
-    "{{@key}}": "{{this}}"{{#unless @last}},{{/unless}}
-    {{/each}}
-  },
-  "featureFlags": {
-    {{#each featureFlags}}
-    "{{@key}}": {{this}}{{#unless @last}},{{/unless}}
-    {{/each}}
-  },
-  "notifications": {
-    "deploymentSuccess": {
-      "enabled": true,
-      "channels": ["email", "teams"],
-      "recipients": [
-        {{#each notificationRecipients}}
-        "{{this}}"{{#unless @last}},{{/unless}}
-        {{/each}}
-      ]
-    },
-    "deploymentFailure": {
-      "enabled": true,
-      "channels": ["email", "teams", "sms"],
-      "recipients": [
-        {{#each notificationRecipients}}
-        "{{this}}"{{#unless @last}},{{/unless}}
-        {{/each}}
-      ]
-    },
-    "healthCheckFailure": {
-      "enabled": true,
-      "channels": ["email", "teams"],
-      "recipients": [
-        {{#each notificationRecipients}}
-        "{{this}}"{{#unless @last}},{{/unless}}
-        {{/each}}
-      ]
-    }
-  }
-}