@xrmforge/devkit 0.6.1 → 0.7.0

package/dist/templates/example-form.ts

@@ -4,58 +4,73 @@
  * Register in D365 as: {{namespace}}.Example.onLoad
  *
  * This template demonstrates the correct patterns:
- * - Fields Enum for compile-time field validation
- * - Typed FormContext cast
+ * - typedForm() for direct typed field access
+ * - Fields Enum for addOnChange and $control
+ * - Entity-level Fields for Web API select() queries
  * - wrapHandler for unified error handling
  * - Logger instead of console.log
  * - FormNotificationLevel constant instead of raw string
- * - select() for Web API queries
+ * - pickLang() for localized UI strings
  *
  * Replace this file with your actual form logic after running 'xrmforge generate'.
  */
 import { createLogger } from '../shared/logger.js';
 import { wrapHandler } from '../shared/error-handler.js';
-import { FormNotificationLevel, select } from '@xrmforge/helpers';
-// TODO: Import your generated types after running 'xrmforge generate'
-// import type { ExampleForm } from '../../generated/entities/Example.js';
-// import { ExampleFormFieldsEnum as Fields } from '../../generated/entities/Example.js';
+import { MESSAGES, pickLang } from '../shared/constants.js';
+import { typedForm, FormNotificationLevel, select, formLookupId } from '@xrmforge/helpers';
+// TODO: After 'xrmforge generate', replace with your actual imports:
+// import type { ExampleForm } from '../../generated/forms/example.js';
+// import { ExampleFormFieldsEnum as Fields } from '../../generated/forms/example.js';
+// import { ExampleFields } from '../../generated/fields/example.js';
+// import { EntityNames } from '../../generated/entity-names.js';
 
 const logger = createLogger('{{namespace}}.Example');
 
 /**
  * Called when the form loads.
  */
-export const onLoad = wrapHandler('{{namespace}}.Example.onLoad', logger, (executionContext) => {
-  const form = executionContext.getFormContext();
-  // TODO: Cast to your generated form type:
-  // const form = executionContext.getFormContext() as ExampleForm;
-
-  // Example: show a notification on the form
-  form.ui.setFormNotification(
-    'Form loaded successfully',
-    FormNotificationLevel.Info,
-    'example-load-notification',
+export const onLoad = wrapHandler('{{namespace}}.Example.onLoad', logger, async (ctx) => {
+  // TODO: Replace 'Xrm.FormContext' with your generated form type:
+  // const form = typedForm<ExampleForm>(ctx.getFormContext());
+  const form = typedForm<Xrm.FormContext>(ctx.getFormContext());
+
+  // Direct field access via typedForm proxy (fully typed):
+  // const name = form.name.getValue();          // string | null
+  // form.revenue.setValue(150000);               // NumberAttribute
+
+  // addOnChange uses Fields Enum via $context:
+  // form.$context.getAttribute(Fields.Name).addOnChange(() => {
+  //   logger.debug('Name changed', { value: form.name.getValue() });
+  // });
+
+  // Web API queries use entity-level Fields:
+  // const result = await Xrm.WebApi.retrieveRecord(
+  //   EntityNames.Account, id,
+  //   select(ExampleFields.Name, ExampleFields.WebsiteUrl)
+  // );
+
+  // Lookup access:
+  // const parentId = formLookupId(form.parentaccountid);
+
+  // Localized UI strings:
+  const lang = pickLang(
+    Xrm.Utility.getGlobalContext().userSettings.languageId,
+    MESSAGES,
   );
+  logger.info('Form loaded', { language: lang });
 
-  // Example: read a field value using Fields Enum
-  // const nameAttr = form.getAttribute(Fields.Name);
-  // logger.debug('Name field value', { value: nameAttr.getValue() });
-
-  // Example: Web API query with select()
-  // const ref = formLookup(form.getAttribute(Fields.ParentAccountId));
-  // if (ref) {
-  //   const result = await Xrm.WebApi.retrieveRecord(
-  //     EntityNames.Account, ref.id, select(AccountFields.Name, AccountFields.WebsiteUrl)
-  //   );
-  // }
+  // Form notifications use constants:
+  form.$context.ui.setFormNotification(
+    'Form loaded',
+    FormNotificationLevel.Info,
+    'example-load',
+  );
 });
 
 /**
  * Called when the form is saved.
  */
-export const onSave = wrapHandler('{{namespace}}.Example.onSave', logger, (executionContext) => {
-  const form = executionContext.getFormContext();
-
-  // Clear the load notification on save
-  form.ui.clearFormNotification('example-load-notification');
+export const onSave = wrapHandler('{{namespace}}.Example.onSave', logger, (ctx) => {
+  const form = typedForm<Xrm.FormContext>(ctx.getFormContext());
+  form.$context.ui.clearFormNotification('example-load');
 });

package/dist/templates/validate-form.mjs

@@ -122,28 +122,33 @@ function checkPattern(label, files, regex, excludeFiles = []) {
 const formFiles = collectTsFiles('src/forms');
 const allSrcFiles = collectTsFiles('src');
 
+// ── Field Access ─────────────────────────────────────────────────────────────
+
 // 3a. Raw strings in getAttribute/getControl (must use Fields Enum)
 checkPattern(
-  'Raw field strings in getAttribute/getControl (must use Fields Enum)',
+  'Raw field strings in getAttribute/getControl',
   formFiles,
   /(?:getAttribute|getControl)\s*\(\s*['"][a-z]/,
 );
 
-// 3b. console.log/warn/error outside logger.ts (must use Logger)
+// 3b. Raw strings in helper wrappers (getValue, setFieldValue, setDisabled, addOnChange, setVisible, setRequiredLevel)
 checkPattern(
-  'console.* outside logger.ts (must use Logger)',
+  'Raw field strings in helper functions (use typedForm or Fields Enum)',
   allSrcFiles,
-  /\bconsole\.(log|warn|error|info|debug)\b/,
-  ['logger.ts'],
+  /(?:getValue|setFieldValue|setDisabled|addOnChange|setVisible|setRequiredLevel|addPreSearch)\s*\(\s*\w+\s*,\s*['"][a-z]/,
+  ['generated/', 'logger.ts'],
 );
 
-// 3c. Exported handlers without wrapHandler
+// 3c. Raw strings in select() (must use entity-level Fields Enum)
 checkPattern(
-  'Exported handlers without wrapHandler',
-  formFiles,
-  /^export\s+(const|async\s+function|function)\s+\w+(?!.*wrapHandler)/,
+  'Raw field strings in select() (use entity-level Fields Enum)',
+  allSrcFiles,
+  /\bselect\s*\(\s*['"][a-z]/,
+  ['generated/'],
 );
 
+// ── Entity Names ─────────────────────────────────────────────────────────────
+
 // 3d. Raw entity name strings in WebApi calls (must use EntityNames Enum)
 checkPattern(
   'Raw entity names in WebApi (must use EntityNames Enum)',
@@ -152,14 +157,73 @@ checkPattern(
   ['generated/'],
 );
 
-// 3e. Xrm.Page (deprecated since D365 v9.0)
+// 3e. SystemEntities workaround (must extend generation instead)
+checkPattern(
+  'SystemEntities workaround (extend generation with --entities instead)',
+  allSrcFiles,
+  /SystemEntities\./,
+);
+
+// ── Magic Values ─────────────────────────────────────────────────────────────
+
+// 3f. Magic numbers in OptionSet comparisons (must use OptionSet Enum)
+checkPattern(
+  'Magic numbers in value comparisons (use OptionSet Enum)',
+  allSrcFiles,
+  /getValue\(\)\s*===?\s*\d{3,}/,
+  ['generated/'],
+);
+
+// 3g. Magic number 86400000 (must use named constant MS_PER_DAY)
+checkPattern(
+  'Magic number 86400000 (use named constant MS_PER_DAY)',
+  allSrcFiles,
+  /86400000/,
+);
+
+// 3h. Raw notification level strings (must use FormNotificationLevel)
+checkPattern(
+  'Raw notification level strings (use FormNotificationLevel from @xrmforge/helpers)',
+  allSrcFiles,
+  /setFormNotification\s*\([^)]*['"](?:ERROR|WARNING|INFO)['"]/,
+);
+
+// ── Deprecated / Unsafe ──────────────────────────────────────────────────────
+
+// 3i. Xrm.Page (deprecated since D365 v9.0)
 checkPattern(
   'Xrm.Page (deprecated since D365 v9.0)',
   allSrcFiles,
   /\bXrm\.Page\b/,
 );
 
-// 3f. Raw $select strings (must use select() from @xrmforge/helpers)
+// 3j. eval() usage
+checkPattern(
+  'eval() usage (use Number() or JSON.parse())',
+  allSrcFiles,
+  /\beval\s*\(/,
+);
+
+// 3k. console.log/warn/error outside logger.ts (must use Logger)
+checkPattern(
+  'console.* outside logger.ts (must use Logger)',
+  allSrcFiles,
+  /\bconsole\.(log|warn|error|info|debug)\b/,
+  ['logger.ts'],
+);
+
+// ── Handler Pattern ──────────────────────────────────────────────────────────
+
+// 3l. Exported handlers without wrapHandler
+checkPattern(
+  'Exported handlers without wrapHandler',
+  formFiles,
+  /^export\s+(const|async\s+function|function)\s+\w+(?!.*wrapHandler)/,
+);
+
+// ── Raw $select ──────────────────────────────────────────────────────────────
+
+// 3m. Raw $select strings (must use select() from @xrmforge/helpers)
 checkPattern(
   'Raw $select strings (must use select() from @xrmforge/helpers)',
   allSrcFiles,
@@ -167,6 +231,24 @@ checkPattern(
   ['generated/'],
 );
 
+// ── FetchXML ─────────────────────────────────────────────────────────────────
+
+// 3n. Raw field names in FetchXML attribute= (should use Fields Enum interpolation)
+checkPattern(
+  'Raw field names in FetchXML (use Fields Enum interpolation)',
+  allSrcFiles,
+  /attribute\s*=\s*'[a-z][a-z0-9_]+'/,
+  ['generated/'],
+);
+
+// 3o. Magic numbers in FetchXML <value> (should use OptionSet Enum)
+checkPattern(
+  'Magic numbers in FetchXML values (use OptionSet Enum)',
+  allSrcFiles,
+  /<value>\d{3,}<\/value>/,
+  ['generated/'],
+);
+
 // ============================================================
 // Result
 // ============================================================

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xrmforge/devkit",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Build orchestration and project tooling for Dynamics 365 WebResources",
   "keywords": [
     "dynamics-365",