@xrmforge/typegen 0.11.1 → 0.12.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 XrmForge Contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 XrmForge Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -489,6 +489,10 @@ interface SystemFormMetadata {
     formxml: string;
     description: string | null;
     isdefault: boolean;
+    /** Form type (systemform_type): 2 = Main, 7 = Quick Create, ... */
+    type: number;
+    /** Activation state (systemform_formactivationstate): 0 = Inactive, 1 = Active */
+    formactivationstate: number;
 }
 /** Parsed data-bound control from FormXml (bound to an attribute) */
 interface FormControl {
@@ -541,6 +545,8 @@ interface ParsedForm {
     name: string;
     formId: string;
     isDefault: boolean;
+    /** Form type (systemform_type): 2 = Main, 7 = Quick Create */
+    type: number;
     tabs: FormTab[];
     /** All data-bound controls across all tabs/sections (flattened) */
     allControls: FormControl[];
@@ -712,10 +718,14 @@ declare class MetadataClient {
      */
     getStateAttributes(logicalName: string): Promise<StateAttributeMetadata[]>;
     /**
-     * Get and parse Main forms (type=2) for an entity.
-     * Returns parsed form structures with tabs, sections, and controls.
+     * Get and parse the form types relevant for type generation (Main type=2 and
+     * Quick Create type=7), restricted to ACTIVE forms (formactivationstate=1).
+     * Inactive forms are leftovers that no app surfaces, so they get no interface -
+     * this applies to both Main and Quick Create forms.
+     *
+     * Returns parsed form structures with tabs, sections, controls, and the form type.
      */
-    getMainForms(logicalName: string): Promise<ParsedForm[]>;
+    getForms(logicalName: string): Promise<ParsedForm[]>;
     /**
      * Get a global OptionSet by its exact name.
      */
@@ -1199,17 +1209,15 @@ declare function disambiguateEnumMembers(members: Array<{
 /**
  * @xrmforge/typegen - Entity Interface Generator
  *
- * Generates TypeScript declaration files (.d.ts) for Dataverse entity interfaces.
+ * Generates Dataverse entity interfaces as a flat ES module (.ts file).
  * These interfaces represent the data types returned by the Web API.
  *
- * Output pattern:
+ * Output pattern (flat ES module, one file per entity):
  * ```typescript
- * declare namespace XrmForge.Entities {
- *   interface Account {
- *     accountid: string | null;
- *     name: string | null;
- *     // ...
- *   }
+ * export interface Account {
+ *   accountid: string;
+ *   name: string | null;
+ *   // ...
  * }
  * ```
  */
@@ -1224,7 +1232,7 @@ interface EntityGeneratorOptions {
  *
  * @param info - Complete entity metadata (from MetadataClient.getEntityTypeInfo)
  * @param options - Generator options
- * @returns TypeScript declaration string (.d.ts content)
+ * @returns TypeScript source string (flat ES module)
  */
 declare function generateEntityInterface(info: EntityTypeInfo, options?: EntityGeneratorOptions): string;
 
@@ -1235,13 +1243,11 @@ declare function generateEntityInterface(info: EntityTypeInfo, options?: EntityG
  * Uses const enum because D365 form scripts have no module system at runtime,
  * so enum values must be inlined at compile time.
  *
- * Output pattern:
+ * Output pattern (flat ES module, all OptionSets of an entity in one file):
  * ```typescript
- * declare namespace XrmForge.OptionSets {
- *   const enum AccountCategoryCode {
- *     PreferredCustomer = 1,
- *     Standard = 2,
- *   }
+ * export const enum AccountCategoryCode {
+ *   PreferredCustomer = 1,
+ *   Standard = 2,
  * }
  * ```
  */
@@ -1291,38 +1297,37 @@ declare function generateEntityOptionSets(picklistAttributes: Array<{
  * 4. Fields const enum: provides autocomplete with dual-language labels
  * 5. NO fallback getAttribute(name: string): unknown fields are compile errors
  *
- * Output pattern:
+ * Output pattern (flat ES module, one file per entity, all forms combined):
  * ```typescript
- * declare namespace XrmForge.Forms.Account {
- *   type AccountMainFormFields = "name" | "telephone1" | "revenue";
- *
- *   type AccountMainFormAttributeMap = {
- *     name: Xrm.Attributes.StringAttribute;
- *     telephone1: Xrm.Attributes.StringAttribute;
- *     revenue: Xrm.Attributes.NumberAttribute;
- *   };
- *
- *   type AccountMainFormControlMap = {
- *     name: Xrm.Controls.StringControl;
- *     telephone1: Xrm.Controls.StringControl;
- *     revenue: Xrm.Controls.NumberControl;
- *   };
- *
- *   const enum AccountMainFormFields {
- *     Name = 'name',
- *     Telephone1 = 'telephone1',
- *     Revenue = 'revenue',
- *   }
- *
- *   interface AccountMainForm extends Omit<Xrm.FormContext, 'getAttribute' | 'getControl'> {
- *     getAttribute<K extends AccountMainFormFields>(name: K): AccountMainFormAttributeMap[K];
- *     getAttribute(index: number): Xrm.Attributes.Attribute;
- *     getAttribute(): Xrm.Attributes.Attribute[];
- *     getControl<K extends AccountMainFormFields>(name: K): AccountMainFormControlMap[K];
- *     getControl(index: number): Xrm.Controls.Control;
- *     getControl(): Xrm.Controls.Control[];
- *   }
+ * export type AccountMainFormFields = "name" | "telephone1" | "revenue";
+ *
+ * export type AccountMainFormAttributeMap = {
+ *   name: Xrm.Attributes.StringAttribute;
+ *   telephone1: Xrm.Attributes.StringAttribute;
+ *   revenue: Xrm.Attributes.NumberAttribute;
+ * };
+ *
+ * export type AccountMainFormControlMap = {
+ *   name: Xrm.Controls.StringControl;
+ *   telephone1: Xrm.Controls.StringControl;
+ *   revenue: Xrm.Controls.NumberControl;
+ * };
+ *
+ * export const enum AccountMainFormFieldsEnum {
+ *   Name = 'name',
+ *   Telephone1 = 'telephone1',
+ *   Revenue = 'revenue',
+ * }
+ *
+ * export interface AccountMainForm extends Omit<Xrm.FormContext, 'getAttribute' | 'getControl'> {
+ *   getAttribute<K extends AccountMainFormFields>(name: K): AccountMainFormAttributeMap[K];
+ *   getAttribute(index: number): Xrm.Attributes.Attribute;
+ *   getAttribute(): Xrm.Attributes.Attribute[];
+ *   getControl<K extends AccountMainFormFields>(name: K): AccountMainFormControlMap[K];
+ *   getControl(index: number): Xrm.Controls.Control;
+ *   getControl(): Xrm.Controls.Control[];
  * }
+ * // plus ...FormTabs/...Sections/...FormSubgrids enums, ...FormTypeInfo, ...FormMockValues
  * ```
  */
 
@@ -1364,15 +1369,13 @@ declare function generateEntityForms(forms: ParsedForm[], entityLogicalName: str
  * Generates a const enum with ALL entity fields for use with Xrm.WebApi.
  * Unlike form-specific Fields enums, this contains every readable attribute.
  *
- * Output pattern:
+ * Output pattern (flat ES module):
  * ```typescript
- * declare namespace XrmForge.Entities {
- *   const enum AccountFields {
- *     /** Account Name | Firmenname *\/
- *     Name = 'name',
- *     /** Main Phone | Haupttelefon *\/
- *     Telephone1 = 'telephone1',
- *   }
+ * export const enum AccountFields {
+ *   /** Account Name | Firmenname *\/
+ *   Name = 'name',
+ *   /** Main Phone | Haupttelefon *\/
+ *   Telephone1 = 'telephone1',
  * }
  * ```
  */
@@ -1422,14 +1425,12 @@ declare function generateEntityNavigationProperties(info: EntityTypeInfo, option
  * Generates a single const enum with all entity logical names.
  * Eliminates raw strings in Xrm.WebApi calls.
  *
- * Output pattern:
+ * Output pattern (flat ES module):
  * ```typescript
- * declare namespace XrmForge {
- *   const enum EntityNames {
- *     Account = 'account',
- *     Contact = 'contact',
- *     Lead = 'lead',
- *   }
+ * export const enum EntityNames {
+ *   Account = 'account',
+ *   Contact = 'contact',
+ *   Lead = 'lead',
  * }
  * ```
  */
@@ -1447,24 +1448,20 @@ declare function generateEntityNamesEnum(entityNames: string[], _options?: Entit
 /**
  * @xrmforge/typegen - Action/Function Generator
  *
- * Generates TypeScript files for type-safe Custom API execution:
- * - .d.ts: Parameter/Response interfaces and executor types
- * - .ts: Runtime modules that import factory functions from @xrmforge/helpers
+ * Generates a flat ES module (.ts) per Custom API group: exported Param/Result
+ * interfaces plus runtime executors that import factory functions from @xrmforge/helpers.
  *
  * Input: CustomApiTypeInfo[] (from fixture JSON or live Dataverse query)
  * Output: Grouped by entity (bound) or "global" (unbound)
  *
- * @example Generated output for markant_NormalizePhone (unbound action):
+ * @example Generated output for markant_NormalizePhone (unbound action) in actions/global.ts:
  * ```typescript
- * // global.d.ts
- * declare namespace XrmForge.Actions {
- *   interface NormalizePhoneParams { Input: string; AllowSuspicious?: boolean; }
- *   interface NormalizePhoneResult { Normalized: string; Status: number; Message: string; }
- * }
- *
- * // global.ts
  * import { createUnboundAction } from '@xrmforge/helpers';
- * export const NormalizePhone = createUnboundAction<...>('markant_NormalizePhone', { ... });
+ *
+ * export type NormalizePhoneParams = { Input: string; AllowSuspicious?: boolean; };
+ * export type NormalizePhoneResult = { Normalized: string; Status: number; Message: string; };
+ * export const NormalizePhone =
+ *   createUnboundAction<NormalizePhoneParams, NormalizePhoneResult>('markant_NormalizePhone', { ... });
  * ```
  */
 
@@ -1485,7 +1482,7 @@ interface ActionGeneratorOptions {
 declare function generateActionDeclarations(apis: CustomApiTypeInfo[], _isFunction: boolean, _entityName?: string, _options?: ActionGeneratorOptions): string;
 /**
  * Generate a single .ts file with both interfaces and runtime executors for a group of Custom APIs.
- * Combines what was previously split into .d.ts (interfaces) and .ts (executors).
+ * Emits the Param/Result interfaces and the runtime executors together in one .ts file.
  *
  * @param apis - Custom APIs to generate
  * @param isFunction - true for functions, false for actions
@@ -1517,7 +1514,7 @@ interface GenerateConfig {
     entities: string[];
     /** Solution unique names to discover entities automatically (merged with entities, deduplicated) */
     solutionNames?: string[];
-    /** Output directory for generated .d.ts files */
+    /** Output directory for generated .ts files */
     outputDir: string;
     /** Label language configuration */
     labelConfig: LabelConfig;

package/dist/index.js

@@ -774,6 +774,7 @@ function parseForm(form, parser = defaultXmlParser) {
     name: form.name,
     formId: form.formid,
     isDefault: form.isdefault,
+    type: form.type,
     tabs,
     allControls,
     allSpecialControls
@@ -918,13 +919,15 @@ function extractParameter(controlElement, paramName) {
 // src/metadata/client.ts
 var log4 = createLogger("metadata");
 var FORM_TYPE_MAIN = 2;
+var FORM_TYPE_QUICK_CREATE = 7;
+var FORM_ACTIVATION_ACTIVE = 1;
 var COMPONENT_TYPE_ENTITY = 1;
 function byUniqueName(a, b) {
   return a.uniquename < b.uniquename ? -1 : a.uniquename > b.uniquename ? 1 : 0;
 }
 var ENTITY_SELECT = "LogicalName,SchemaName,EntitySetName,DisplayName,PrimaryIdAttribute,PrimaryNameAttribute,OwnershipType,IsCustomEntity,LogicalCollectionName,MetadataId";
 var ATTRIBUTE_SELECT = "LogicalName,SchemaName,AttributeType,AttributeTypeName,DisplayName,IsPrimaryId,IsPrimaryName,RequiredLevel,IsValidForRead,IsValidForCreate,IsValidForUpdate,MetadataId";
-var FORM_SELECT = "name,formid,formxml,description,isdefault";
+var FORM_SELECT = "name,formid,formxml,description,isdefault,type,formactivationstate";
 var MetadataClient = class {
   http;
   constructor(httpClient) {
@@ -1001,16 +1004,22 @@ var MetadataClient = class {
   }
   // ─── Form Metadata ────────────────────────────────────────────────────
   /**
-   * Get and parse Main forms (type=2) for an entity.
-   * Returns parsed form structures with tabs, sections, and controls.
+   * Get and parse the form types relevant for type generation (Main type=2 and
+   * Quick Create type=7), restricted to ACTIVE forms (formactivationstate=1).
+   * Inactive forms are leftovers that no app surfaces, so they get no interface -
+   * this applies to both Main and Quick Create forms.
+   *
+   * Returns parsed form structures with tabs, sections, controls, and the form type.
    */
-  async getMainForms(logicalName) {
+  async getForms(logicalName) {
     const safeName = DataverseHttpClient.sanitizeIdentifier(logicalName);
-    log4.info(`Fetching Main forms for: ${safeName}`);
+    log4.info(`Fetching active Main + Quick Create forms for: ${safeName}`);
     const forms = await this.http.getAll(
-      `/systemforms?$filter=objecttypecode eq '${safeName}' and type eq ${FORM_TYPE_MAIN}&$select=${FORM_SELECT}`
+      `/systemforms?$filter=objecttypecode eq '${safeName}' and (type eq ${FORM_TYPE_MAIN} or type eq ${FORM_TYPE_QUICK_CREATE}) and formactivationstate eq ${FORM_ACTIVATION_ACTIVE}&$select=${FORM_SELECT}`
     );
-    log4.info(`Found ${forms.length} Main form(s) for "${safeName}"`);
+    const mainCount = forms.filter((f) => f.type === FORM_TYPE_MAIN).length;
+    const qcCount = forms.filter((f) => f.type === FORM_TYPE_QUICK_CREATE).length;
+    log4.info(`Found ${mainCount} Main + ${qcCount} Quick Create active form(s) for "${safeName}"`);
     return forms.map((form) => {
       try {
         return parseForm(form);
@@ -1024,6 +1033,7 @@ var MetadataClient = class {
           name: form.name,
           formId: form.formid,
           isDefault: form.isdefault,
+          type: form.type,
           tabs: [],
           allControls: [],
           allSpecialControls: []
@@ -1152,7 +1162,7 @@ var MetadataClient = class {
       this.getLookupAttributes(safeName),
       this.getStatusAttributes(safeName),
       this.getStateAttributes(safeName),
-      this.getMainForms(safeName),
+      this.getForms(safeName),
       this.getRelationships(safeName)
     ]);
     const result = {
@@ -1936,7 +1946,14 @@ function generateEntityOptionSets(picklistAttributes, entityLogicalName, options
   return results;
 }
 
+// src/generators/string-escape.ts
+function singleQuoted(value) {
+  const escaped = value.replace(/\\/g, "\\\\").replace(/'/g, "\\'").replace(/\r/g, "\\r").replace(/\n/g, "\\n");
+  return `'${escaped}'`;
+}
+
 // src/generators/form-generator.ts
+var FORM_TYPE_QUICK_CREATE2 = 7;
 function specialControlToXrmType(controlType) {
   switch (controlType) {
     case "subgrid":
@@ -2065,7 +2082,7 @@ function generateFormInterface(form, entityLogicalName, attributeMap, options =
     if (field.label) {
       lines.push(`  /** ${field.label} */`);
     }
-    lines.push(`  ${field.enumMemberName} = '${field.logicalName}',`);
+    lines.push(`  ${field.enumMemberName} = ${singleQuoted(field.logicalName)},`);
   }
   lines.push("}");
   lines.push("");
@@ -2092,7 +2109,7 @@ function generateFormInterface(form, entityLogicalName, attributeMap, options =
       if (tab.label) {
         lines.push(`  /** ${tab.label} */`);
       }
-      lines.push(`  ${tabMemberNames[i]} = '${tab.name}',`);
+      lines.push(`  ${tabMemberNames[i]} = ${singleQuoted(tab.name)},`);
     }
     lines.push("}");
     lines.push("");
@@ -2117,7 +2134,7 @@ function generateFormInterface(form, entityLogicalName, attributeMap, options =
           sCounter++;
         }
         usedSectionMembers.add(sectionMember);
-        lines.push(`  ${sectionMember} = '${section.name}',`);
+        lines.push(`  ${sectionMember} = ${singleQuoted(section.name)},`);
       }
       lines.push("}");
       lines.push("");
@@ -2142,7 +2159,7 @@ function generateFormInterface(form, entityLogicalName, attributeMap, options =
       usedMembers.add(member);
       const label = sg.targetEntityType ? `Subgrid: ${sg.targetEntityType}` : `Subgrid`;
       lines.push(`  /** ${label} */`);
-      lines.push(`  ${member} = '${sg.id}',`);
+      lines.push(`  ${member} = ${singleQuoted(sg.id)},`);
     }
     lines.push("}");
     lines.push("");
@@ -2162,7 +2179,7 @@ function generateFormInterface(form, entityLogicalName, attributeMap, options =
       }
       usedMembers.add(member);
       lines.push(`  /** Quick View */`);
-      lines.push(`  ${member} = '${qv.id}',`);
+      lines.push(`  ${member} = ${singleQuoted(qv.id)},`);
     }
     lines.push("}");
     lines.push("");
@@ -2239,8 +2256,8 @@ function generateEntityForms(forms, entityLogicalName, attributes, options = {})
   const entityPascal = toPascalCase(entityLogicalName);
   const validForms = forms.filter((f) => f.allControls.length > 0);
   const baseNames = validForms.map((form) => {
-    const safeFormName = toSafeFormName(form.name);
-    return buildFormBaseName(entityPascal, safeFormName);
+    const base = buildFormBaseName(entityPascal, toSafeFormName(form.name));
+    return form.type === FORM_TYPE_QUICK_CREATE2 ? `${base}QuickCreate` : base;
   });
   const baseNameCounts = /* @__PURE__ */ new Map();
   for (const name of baseNames) {