@xrmforge/devkit 0.7.13 → 0.7.15

package/dist/templates/azure-pipelines.yml

@@ -15,16 +15,12 @@ steps:
   - script: npm ci
     displayName: 'Install dependencies'
 
-  # Connection + auth come from the pipeline variables below. Entity scope
-  # (--entities or --solutions) and --output belong in xrmforge.config.json.
+  # Connection + credentials come from the XRMFORGE_* environment below; the CLI reads
+  # them directly, so the secret never appears as a command-line argument (and stays
+  # out of the process list). Entity scope (--entities or --solutions) and --output
+  # belong in xrmforge.config.json.
   # See "npx xrmforge generate --help" for all options (--actions, labels, ...).
-  - script: >
-      npx xrmforge generate
-      --url "$XRMFORGE_URL"
-      --auth client-credentials
-      --tenant-id "$XRMFORGE_TENANT_ID"
-      --client-id "$XRMFORGE_CLIENT_ID"
-      --client-secret "$XRMFORGE_CLIENT_SECRET"
+  - script: npx xrmforge generate --auth client-credentials
     displayName: 'Generate types from Dataverse'
     env:
       XRMFORGE_URL: $(XRMFORGE_URL)

package/dist/templates/constants.ts

@@ -1,32 +1,32 @@
-/**
- * Central constants for notifications and messages.
- */
-
-/** Unique IDs for form-level notifications. */
-export const NOTIFICATION_IDS = {
-  genericError: '{{namespace}}.notification.generic-error'.toLowerCase(),
-} as const;
-
-/** Localized message strings (extend as needed). */
-export const MESSAGES = {
-  de: {
-    unsavedRecord: 'Der Datensatz muss zuerst gespeichert werden.',
-  },
-  en: {
-    unsavedRecord: 'The record must be saved first.',
-  },
-} as const;
-
-/**
- * Pick the correct language table based on the user's D365 language setting.
- *
- * @param languageId - LCID from Xrm.Utility.getGlobalContext().userSettings.languageId
- * @param table - Object with 'de' and 'en' keys containing the same message keys
- * @returns The matching language table (defaults to English)
- */
-export function pickLang<K extends string>(
-  languageId: number,
-  table: { de: Record<K, string>; en: Record<K, string> },
-): Record<K, string> {
-  return languageId === 1031 ? table.de : table.en;
-}
+/**
+ * Central constants for notifications and messages.
+ */
+
+/** Unique IDs for form-level notifications. */
+export const NOTIFICATION_IDS = {
+  genericError: '{{namespace}}.notification.generic-error'.toLowerCase(),
+} as const;
+
+/** Localized message strings (extend as needed). */
+export const MESSAGES = {
+  de: {
+    unsavedRecord: 'Der Datensatz muss zuerst gespeichert werden.',
+  },
+  en: {
+    unsavedRecord: 'The record must be saved first.',
+  },
+} as const;
+
+/**
+ * Pick the correct language table based on the user's D365 language setting.
+ *
+ * @param languageId - LCID from Xrm.Utility.getGlobalContext().userSettings.languageId
+ * @param table - Object with 'de' and 'en' keys containing the same message keys
+ * @returns The matching language table (defaults to English)
+ */
+export function pickLang<K extends string>(
+  languageId: number,
+  table: { de: Record<K, string>; en: Record<K, string> },
+): Record<K, string> {
+  return languageId === 1031 ? table.de : table.en;
+}

package/dist/templates/error-handler.ts

@@ -1,96 +1,96 @@
-/**
- * Unified error handling for D365 form event handlers.
- * Wraps sync and async handlers with try/catch and form notifications.
- */
-import type { Logger } from './logger.js';
-import { NOTIFICATION_IDS } from './constants.js';
-import { FormNotificationLevel } from '@xrmforge/helpers';
-
-type EventHandler = (ctx: Xrm.Events.EventContext, ...args: never[]) => unknown;
-
-/**
- * Wrap a form event handler with error handling.
- *
- * Catches both sync and async errors, logs them, and shows a form notification.
- * The original handler is never rethrown, so form execution continues.
- *
- * @param name - Handler name for logging (e.g. 'MyApp.Account.onLoad')
- * @param logger - Logger instance for error reporting
- * @param handler - The actual event handler function
- */
-export function wrapHandler(name: string, logger: Logger, handler: EventHandler): EventHandler {
-  const wrapped: EventHandler = (ctx, ...args) => {
-    try {
-      const result = handler(ctx, ...args);
-      if (result && typeof (result as Promise<unknown>).then === 'function') {
-        return (result as Promise<unknown>).catch((err: unknown) => {
-          logAndNotify(ctx, name, logger, err);
-        });
-      }
-      return result;
-    } catch (err: unknown) {
-      logAndNotify(ctx, name, logger, err);
-    }
-  };
-  return wrapped;
-}
-
-/**
- * Wrap a ribbon command handler with error handling.
- *
- * Unlike wrapHandler, this accepts a FormContext directly (not an EventContext),
- * which is the calling convention for ribbon/command bar handlers.
- *
- * @param name - Handler name for logging
- * @param logger - Logger instance for error reporting
- * @param handler - The actual command handler function
- */
-export function wrapCommand(
-  name: string,
-  logger: Logger,
-  handler: (formContext: Xrm.FormContext, ...args: never[]) => unknown,
-): (formContext: Xrm.FormContext, ...args: never[]) => unknown {
-  return (formContext, ...args) => {
-    try {
-      const result = handler(formContext, ...args);
-      if (result && typeof (result as Promise<unknown>).then === 'function') {
-        return (result as Promise<unknown>).catch((err: unknown) => {
-          logAndNotifyForm(formContext, name, logger, err);
-        });
-      }
-      return result;
-    } catch (err: unknown) {
-      logAndNotifyForm(formContext, name, logger, err);
-    }
-  };
-}
-
-function logAndNotify(
-  ctx: Xrm.Events.EventContext,
-  name: string,
-  logger: Logger,
-  err: unknown,
-): void {
-  const message = err instanceof Error ? err.message : String(err);
-  logger.error(`${name} failed`, { err });
-  try {
-    ctx.getFormContext().ui.setFormNotification(message, FormNotificationLevel.Error, NOTIFICATION_IDS.genericError);
-  } catch {
-    /* ignore */
-  }
-}
-
-function logAndNotifyForm(
-  formContext: Xrm.FormContext,
-  name: string,
-  logger: Logger,
-  err: unknown,
-): void {
-  const message = err instanceof Error ? err.message : String(err);
-  logger.error(`${name} failed`, { err });
-  try {
-    formContext.ui.setFormNotification(message, FormNotificationLevel.Error, NOTIFICATION_IDS.genericError);
-  } catch {
-    /* ignore */
-  }
-}
+/**
+ * Unified error handling for D365 form event handlers.
+ * Wraps sync and async handlers with try/catch and form notifications.
+ */
+import type { Logger } from './logger.js';
+import { NOTIFICATION_IDS } from './constants.js';
+import { FormNotificationLevel } from '@xrmforge/helpers';
+
+type EventHandler = (ctx: Xrm.Events.EventContext, ...args: never[]) => unknown;
+
+/**
+ * Wrap a form event handler with error handling.
+ *
+ * Catches both sync and async errors, logs them, and shows a form notification.
+ * The original handler is never rethrown, so form execution continues.
+ *
+ * @param name - Handler name for logging (e.g. 'MyApp.Account.onLoad')
+ * @param logger - Logger instance for error reporting
+ * @param handler - The actual event handler function
+ */
+export function wrapHandler(name: string, logger: Logger, handler: EventHandler): EventHandler {
+  const wrapped: EventHandler = (ctx, ...args) => {
+    try {
+      const result = handler(ctx, ...args);
+      if (result && typeof (result as Promise<unknown>).then === 'function') {
+        return (result as Promise<unknown>).catch((err: unknown) => {
+          logAndNotify(ctx, name, logger, err);
+        });
+      }
+      return result;
+    } catch (err: unknown) {
+      logAndNotify(ctx, name, logger, err);
+    }
+  };
+  return wrapped;
+}
+
+/**
+ * Wrap a ribbon command handler with error handling.
+ *
+ * Unlike wrapHandler, this accepts a FormContext directly (not an EventContext),
+ * which is the calling convention for ribbon/command bar handlers.
+ *
+ * @param name - Handler name for logging
+ * @param logger - Logger instance for error reporting
+ * @param handler - The actual command handler function
+ */
+export function wrapCommand(
+  name: string,
+  logger: Logger,
+  handler: (formContext: Xrm.FormContext, ...args: never[]) => unknown,
+): (formContext: Xrm.FormContext, ...args: never[]) => unknown {
+  return (formContext, ...args) => {
+    try {
+      const result = handler(formContext, ...args);
+      if (result && typeof (result as Promise<unknown>).then === 'function') {
+        return (result as Promise<unknown>).catch((err: unknown) => {
+          logAndNotifyForm(formContext, name, logger, err);
+        });
+      }
+      return result;
+    } catch (err: unknown) {
+      logAndNotifyForm(formContext, name, logger, err);
+    }
+  };
+}
+
+function logAndNotify(
+  ctx: Xrm.Events.EventContext,
+  name: string,
+  logger: Logger,
+  err: unknown,
+): void {
+  const message = err instanceof Error ? err.message : String(err);
+  logger.error(`${name} failed`, { err });
+  try {
+    ctx.getFormContext().ui.setFormNotification(message, FormNotificationLevel.Error, NOTIFICATION_IDS.genericError);
+  } catch {
+    /* ignore */
+  }
+}
+
+function logAndNotifyForm(
+  formContext: Xrm.FormContext,
+  name: string,
+  logger: Logger,
+  err: unknown,
+): void {
+  const message = err instanceof Error ? err.message : String(err);
+  logger.error(`${name} failed`, { err });
+  try {
+    formContext.ui.setFormNotification(message, FormNotificationLevel.Error, NOTIFICATION_IDS.genericError);
+  } catch {
+    /* ignore */
+  }
+}

package/dist/templates/eslint.config.js

@@ -1,21 +1,21 @@
-import tseslint from '@typescript-eslint/eslint-plugin';
-import tsparser from '@typescript-eslint/parser';
-import xrmforge from '@xrmforge/eslint-plugin';
-
-export default [
-  {
-    files: ['src/**/*.ts'],
-    languageOptions: {
-      parser: tsparser,
-      parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
-    },
-    plugins: { '@typescript-eslint': tseslint },
-    rules: {
-      '@typescript-eslint/no-explicit-any': 'error',
-      '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
-    },
-  },
-  xrmforge.configs.recommended,
-  { rules: { 'no-console': ['error'] } },
-  { files: ['src/shared/logger.ts'], rules: { 'no-console': 'off' } },
-];
+import tseslint from '@typescript-eslint/eslint-plugin';
+import tsparser from '@typescript-eslint/parser';
+import xrmforge from '@xrmforge/eslint-plugin';
+
+export default [
+  {
+    files: ['src/**/*.ts'],
+    languageOptions: {
+      parser: tsparser,
+      parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
+    },
+    plugins: { '@typescript-eslint': tseslint },
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'error',
+      '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+    },
+  },
+  xrmforge.configs.recommended,
+  { rules: { 'no-console': ['error'] } },
+  { files: ['src/shared/logger.ts'], rules: { 'no-console': 'off' } },
+];

package/dist/templates/example-form.test.ts

@@ -1,33 +1,33 @@
-import { describe, it, expect } from 'vitest';
-
-/**
- * Example test for the form script.
- *
- * Uses @xrmforge/testing for type-safe mocking once you have
- * generated types. Replace with real form tests after 'xrmforge generate'.
- */
-describe('{{namespace}}.Example', () => {
-  it('should export onLoad handler', async () => {
-    const mod = await import('../../src/forms/example-form.js');
-    expect(typeof mod.onLoad).toBe('function');
-  });
-
-  it('should export onSave handler', async () => {
-    const mod = await import('../../src/forms/example-form.js');
-    expect(typeof mod.onSave).toBe('function');
-  });
-
-  // TODO: After running 'xrmforge generate', add real form tests.
-  // createFormMock<TForm>() takes the generated FORM interface and returns a
-  // FormMock: use mock.asEventContext() for the handler and mock.ui /
-  // mock.getControl() for assertions (plain mocks, not vi.fn() spies).
-  //
-  // import { createFormMock } from '@xrmforge/testing';
-  // import type { ExampleForm } from '../../generated/forms/example.js';
-  //
-  // it('should show notification on load', () => {
-  //   const mock = createFormMock<ExampleForm>({ name: 'Contoso Ltd' });
-  //   onLoad(mock.asEventContext());
-  //   expect(mock.ui.getFormNotification('example-load')?.message).toBe('Form loaded');
-  // });
-});
+import { describe, it, expect } from 'vitest';
+
+/**
+ * Example test for the form script.
+ *
+ * Uses @xrmforge/testing for type-safe mocking once you have
+ * generated types. Replace with real form tests after 'xrmforge generate'.
+ */
+describe('{{namespace}}.Example', () => {
+  it('should export onLoad handler', async () => {
+    const mod = await import('../../src/forms/example-form.js');
+    expect(typeof mod.onLoad).toBe('function');
+  });
+
+  it('should export onSave handler', async () => {
+    const mod = await import('../../src/forms/example-form.js');
+    expect(typeof mod.onSave).toBe('function');
+  });
+
+  // TODO: After running 'xrmforge generate', add real form tests.
+  // createFormMock<TForm>() takes the generated FORM interface and returns a
+  // FormMock: use mock.asEventContext() for the handler and mock.ui /
+  // mock.getControl() for assertions (plain mocks, not vi.fn() spies).
+  //
+  // import { createFormMock } from '@xrmforge/testing';
+  // import type { ExampleForm } from '../../generated/forms/example.js';
+  //
+  // it('should show notification on load', () => {
+  //   const mock = createFormMock<ExampleForm>({ name: 'Contoso Ltd' });
+  //   onLoad(mock.asEventContext());
+  //   expect(mock.ui.getFormNotification('example-load')?.message).toBe('Form loaded');
+  // });
+});

package/dist/templates/example-form.ts

@@ -1,77 +1,77 @@
-/**
- * Example Form Script for Dynamics 365 using XrmForge best practices.
- *
- * Register in D365 as: {{namespace}}.Example.onLoad
- *
- * This template demonstrates the correct patterns:
- * - typedForm() for direct typed field access
- * - Fields Enum for addOnChange via $context, controls proxy for control access
- * - Entity-level Fields for Web API select() queries
- * - wrapHandler for unified error handling
- * - Logger instead of console.log
- * - FormNotificationLevel constant instead of raw string
- * - 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 { MESSAGES, pickLang } from '../shared/constants.js';
-// For Web API queries and lookups also import: select, formLookupId
-import { typedForm, FormNotificationLevel } from '@xrmforge/helpers';
-// TODO: After 'xrmforge generate', replace with your actual imports:
-// import type { ExampleFormTypeInfo } 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, async (ctx) => {
-  // TODO: Replace 'Xrm.FormContext' with your generated <Form>TypeInfo type:
-  // const form = typedForm<ExampleFormTypeInfo>(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 });
-
-  // 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, (ctx) => {
-  const form = typedForm<Xrm.FormContext>(ctx.getFormContext());
-  form.$context.ui.clearFormNotification('example-load');
-});
+/**
+ * Example Form Script for Dynamics 365 using XrmForge best practices.
+ *
+ * Register in D365 as: {{namespace}}.Example.onLoad
+ *
+ * This template demonstrates the correct patterns:
+ * - typedForm() for direct typed field access
+ * - Fields Enum for addOnChange via $context, controls proxy for control access
+ * - Entity-level Fields for Web API select() queries
+ * - wrapHandler for unified error handling
+ * - Logger instead of console.log
+ * - FormNotificationLevel constant instead of raw string
+ * - 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 { MESSAGES, pickLang } from '../shared/constants.js';
+// For Web API queries and lookups also import: select, formLookupId
+import { typedForm, FormNotificationLevel } from '@xrmforge/helpers';
+// TODO: After 'xrmforge generate', replace with your actual imports:
+// import type { ExampleFormTypeInfo } 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, async (ctx) => {
+  // TODO: Replace 'Xrm.FormContext' with your generated <Form>TypeInfo type:
+  // const form = typedForm<ExampleFormTypeInfo>(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 });
+
+  // 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, (ctx) => {
+  const form = typedForm<Xrm.FormContext>(ctx.getFormContext());
+  form.$context.ui.clearFormNotification('example-load');
+});

package/dist/templates/github-actions-ci.yml

@@ -20,16 +20,12 @@ jobs:
       - run: npm ci
 
       - name: Generate types from Dataverse
-        # Connection + auth come from the repository secrets below. Entity scope
-        # (--entities or --solutions) and --output belong in xrmforge.config.json.
+        # Connection + credentials come from the XRMFORGE_* environment below; the CLI
+        # reads them directly, so the secret never appears as a command-line argument
+        # (and stays out of the process list). Entity scope (--entities or --solutions)
+        # and --output belong in xrmforge.config.json.
         # See "npx xrmforge generate --help" for all options (--actions, labels, ...).
-        run: >
-          npx xrmforge generate
-          --url "$XRMFORGE_URL"
-          --auth client-credentials
-          --tenant-id "$XRMFORGE_TENANT_ID"
-          --client-id "$XRMFORGE_CLIENT_ID"
-          --client-secret "$XRMFORGE_CLIENT_SECRET"
+        run: npx xrmforge generate --auth client-credentials
         env:
           XRMFORGE_URL: ${{ secrets.XRMFORGE_URL }}
           XRMFORGE_TENANT_ID: ${{ secrets.XRMFORGE_TENANT_ID }}

package/dist/templates/gitignore

@@ -7,6 +7,10 @@ dist/
 # XrmForge cache
 .xrmforge/
 
+# Local environment / secrets (never commit; xrmforge generate may write .env)
+.env
+.env.local
+
 # IDE
 .vscode/settings.json
 .idea/