npm - @khester/create-dynamics-app - Versions diffs - 1.0.8 → 1.1.0 - Mend

@khester/create-dynamics-app 1.0.8 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (107) hide show

package/templates/dynamics-365-starter/package.json CHANGED Viewed

@@ -5,11 +5,28 @@
   "main": "dist/index.js",
   "scripts": {
     "build": "webpack --mode=production",
+    "build:dev": "node scripts/custom-build.js --dev",
+    "build:prod": "node scripts/custom-build.js",
+    "build:d365": "node scripts/custom-build.js",
     "dev": "webpack serve --mode=development",
     "start": "webpack serve --mode=development",
+    "serve": "serve -s dist -l 62874",
     "typecheck": "tsc --noEmit",
     "clean": "rimraf dist",
-    "lint": "eslint src --ext .ts,.tsx"
+    "lint": "eslint src --ext .ts,.tsx",
+    "lint:fix": "eslint src --ext .ts,.tsx --fix",
+    "quality": "npm run lint && npm run typecheck",
+    "quality:fix": "npm run lint:fix && npm run typecheck",
+    "validate": "npm run quality && npm run build:prod",
+    "test:build": "npm run clean && npm run build:dev && npm run build:prod",
+    "test:serve": "npm run build:prod && npm run serve",
+    "precommit": "npm run quality",
+    "prepublishOnly": "npm run validate",
+    "generate:entity": "node tools/entity-generator/index.js generate",
+    "metadata:pull": "node tools/metadata-sync/index.js pull",
+    "metadata:generate": "node tools/metadata-sync/index.js generate",
+    "metadata:validate": "node tools/metadata-sync/index.js validate",
+    "metadata:sync": "node tools/metadata-sync/index.js sync"
   },
   "dependencies": {
     "@khester/dynamics-ui-api-client": "^1.0.0",
@@ -20,8 +37,12 @@
   "devDependencies": {
     "@types/react": "^18.2.0",
     "@types/react-dom": "^18.2.0",
+    "commander": "^11.1.0",
     "css-loader": "^6.8.1",
+    "eslint": "^8.57.0",
     "html-webpack-plugin": "^5.5.3",
+    "rimraf": "^5.0.5",
+    "serve": "^14.2.1",
     "style-loader": "^3.3.3",
     "ts-loader": "^9.5.1",
     "typescript": "^5.3.3",

package/templates/dynamics-365-starter/public/index.html CHANGED Viewed

@@ -1,18 +1,15 @@
 <!DOCTYPE html>
 <html lang="en">
-  <head>
+<head>
     <meta charset="utf-8" />
-    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <link rel="icon" href="data:," />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <meta name="theme-color" content="#0078d4" />
-    <meta
-      name="description"
-      content="Dynamics 365 application built with Dynamics UI Kit"
-    />
+    <meta name="theme-color" content="#000000" />
+    <meta name="description" content="Dynamics 365 Application built with Dynamics UI Kit" />
     <title>Dynamics 365 App - Dynamics UI Kit</title>
-  </head>
-  <body>
+</head>
+<body>
     <noscript>You need to enable JavaScript to run this app.</noscript>
     <div id="root"></div>
-  </body>
-</html>
+</body>
+</html>

package/templates/dynamics-365-starter/scripts/custom-build.js ADDED Viewed

@@ -0,0 +1,255 @@
+const webpack = require('webpack');
+const path = require('path');
+const fs = require('fs');
+// Get webpack config
+const webpackConfigPath = path.resolve(__dirname, '../webpack.config.js');
+const getWebpackConfig = require(webpackConfigPath);
+// Check command line arguments for dev mode
+const isDev = process.argv.includes('--dev') || process.argv.includes('-dev');
+const mode = isDev ? 'development' : 'production';
+console.log(`Custom Build Script - Mode: ${mode}`);
+// Create custom webpack config for D365 deployment
+function createD365WebpackConfig() {
+  // Get base config
+  const baseConfig = getWebpackConfig({}, { mode });
+  // D365-specific optimizations
+  const d365Config = {
+    ...baseConfig,
+    mode,
+    optimization: {
+      // Disable code splitting for single file deployment
+      splitChunks: {
+        cacheGroups: {
+          default: false,
+          vendors: false,
+        },
+      },
+      // Disable runtime chunk
+      runtimeChunk: false,
+      // Control minimization based on mode
+      minimize: !isDev,
+    },
+    output: {
+      ...baseConfig.output,
+      // Remove hashes for consistent D365 web resource naming
+      filename: '[name].js',
+      chunkFilename: '[name].chunk.js',
+      assetModuleFilename: '[name][ext]',
+      // Set public path for D365 context
+      publicPath: './',
+    },
+    // Add performance hints for large bundles
+    performance: {
+      hints: isDev ? false : 'warning',
+      maxEntrypointSize: 2000000, // 2MB - reasonable for D365
+      maxAssetSize: 2000000,
+    },
+  };
+  // Modify CSS handling for single file output
+  const rules = d365Config.module.rules.map((rule) => {
+    if (rule.test && rule.test.toString().includes('css')) {
+      return {
+        ...rule,
+        use: [
+          'style-loader', // Inline CSS instead of separate files
+          'css-loader',
+        ],
+      };
+    }
+    return rule;
+  });
+  d365Config.module.rules = rules;
+  // Modify HTML plugin for D365
+  const htmlPluginIndex = d365Config.plugins.findIndex(
+    (plugin) => plugin.constructor.name === 'HtmlWebpackPlugin'
+  );
+  if (htmlPluginIndex !== -1) {
+    d365Config.plugins[htmlPluginIndex] = new (require('html-webpack-plugin'))({
+      template: './public/index.html',
+      filename: 'index.html',
+      inject: 'body',
+      // Inline all assets for single-file deployment
+      inlineSource: isDev ? false : '.(js|css)$',
+    });
+  }
+  // Add banner for D365 deployment info
+  d365Config.plugins.push(
+    new webpack.BannerPlugin({
+      banner: `
+Dynamics 365 Custom Page Bundle
+Built: ${new Date().toISOString()}
+Mode: ${mode}
+Environment: ${isDev ? 'Development' : 'Production'}
+Generated with Dynamics UI Kit
+      `.trim(),
+      raw: false,
+    })
+  );
+  // Add define plugin for environment variables
+  d365Config.plugins.push(
+    new webpack.DefinePlugin({
+      'process.env.NODE_ENV': JSON.stringify(mode),
+      'process.env.D365_BUILD': JSON.stringify(true),
+      'process.env.BUILD_MODE': JSON.stringify(mode),
+    })
+  );
+  return d365Config;
+}
+// Build function
+function build() {
+  const config = createD365WebpackConfig();
+  console.log('Starting D365-optimized build...');
+  console.log(`Output directory: ${config.output.path}`);
+  console.log(
+    `Bundle splitting: ${config.optimization.splitChunks ? 'enabled' : 'disabled'}`
+  );
+  console.log(`Minimization: ${config.optimization.minimize}`);
+  const compiler = webpack(config);
+  compiler.run((err, stats) => {
+    if (err) {
+      console.error('Build failed with error:', err);
+      process.exit(1);
+    }
+    if (stats.hasErrors()) {
+      console.error('Build completed with errors:');
+      console.error(
+        stats.toString({
+          colors: true,
+          chunks: false,
+          modules: false,
+          errorDetails: true,
+        })
+      );
+      process.exit(1);
+    }
+    if (stats.hasWarnings()) {
+      console.warn('Build completed with warnings:');
+      console.warn(
+        stats.toString({
+          colors: true,
+          chunks: false,
+          modules: false,
+          warningsFilter: /export.*was not found in/,
+        })
+      );
+    }
+    console.log('Build completed successfully!');
+    console.log(
+      stats.toString({
+        colors: true,
+        chunks: false,
+        modules: false,
+        assets: true,
+        performance: true,
+      })
+    );
+    // Generate deployment info
+    generateDeploymentInfo(stats, config);
+    compiler.close((closeErr) => {
+      if (closeErr) {
+        console.error('Error closing compiler:', closeErr);
+      }
+    });
+  });
+}
+// Generate deployment information file
+function generateDeploymentInfo(stats, config) {
+  const distPath = config.output.path;
+  const deploymentInfo = {
+    buildTime: new Date().toISOString(),
+    mode: config.mode,
+    isDevelopment: isDev,
+    assets: [],
+    entrypoints: {},
+    performance: {
+      totalSize: 0,
+      maxAssetSize: config.performance?.maxAssetSize || 'unlimited',
+      maxEntrypointSize: config.performance?.maxEntrypointSize || 'unlimited',
+    },
+    d365Integration: {
+      singleFileDeployment: !config.optimization.splitChunks,
+      webResourceReady: true,
+      customPageReady: true,
+      pcfReady: true,
+    },
+  };
+  const compilation = stats.compilation;
+  // Collect asset information
+  Object.keys(compilation.assets).forEach((assetName) => {
+    const asset = compilation.assets[assetName];
+    const assetInfo = {
+      name: assetName,
+      size: asset.size(),
+      type: path.extname(assetName) || 'unknown',
+    };
+    deploymentInfo.assets.push(assetInfo);
+    deploymentInfo.performance.totalSize += assetInfo.size;
+  });
+  // Collect entrypoint information
+  if (compilation.entrypoints) {
+    compilation.entrypoints.forEach((entrypoint, entryName) => {
+      const files = entrypoint.getFiles ? entrypoint.getFiles() : [];
+      deploymentInfo.entrypoints[entryName] = {
+        assets: files,
+        size: files.reduce((total, fileName) => {
+          const asset = compilation.assets[fileName];
+          return total + (asset ? asset.size() : 0);
+        }, 0),
+      };
+    });
+  }
+  // Write deployment info file
+  const deploymentInfoPath = path.join(distPath, 'deployment-info.json');
+  fs.writeFileSync(deploymentInfoPath, JSON.stringify(deploymentInfo, null, 2));
+  console.log('\n📋 Deployment Information:');
+  console.log(
+    `   Total bundle size: ${(deploymentInfo.performance.totalSize / 1024).toFixed(2)} KB`
+  );
+  console.log(`   Assets generated: ${deploymentInfo.assets.length}`);
+  console.log(`   Deployment info saved: ${deploymentInfoPath}`);
+  // D365 deployment recommendations
+  console.log('\n🚀 D365 Deployment Guidelines:');
+  console.log('   1. Upload JS files as Script (JScript) web resources');
+  console.log('   2. Upload CSS files as Style Sheet (CSS) web resources');
+  console.log('   3. Upload HTML file as Web Page (HTML) web resource');
+  console.log('   4. Set "Available for Dynamics 365 mobile" if needed');
+  console.log('   5. Publish all web resources after upload');
+  if (deploymentInfo.performance.totalSize > 1000000) {
+    console.log('\n⚠️  Warning: Bundle size is large (>1MB). Consider:');
+    console.log('   - Using code splitting for better performance');
+    console.log('   - Removing unused dependencies');
+    console.log('   - Enabling compression in D365');
+  }
+}
+// Start the build
+build();

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

@@ -0,0 +1,234 @@
+# 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 ADDED Viewed

@@ -0,0 +1,114 @@
+{
+  "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
+    }
+  }
+}