@xrmforge/typegen 0.5.1 → 0.6.0

package/LICENSE

@@ -0,0 +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.

package/MIGRATION.md

@@ -87,7 +87,7 @@ var value = formContext.getAttribute("primarycontactid").getValue();
 var id = value[0].id.replace("{","").replace("}","");
 
 // After: use parseLookup from @xrmforge/typegen
-import { parseLookup } from '@xrmforge/typegen';
+import { parseLookup } from '@xrmforge/typegen/helpers';
 const contact = parseLookup(form.getAttribute(Fields.PrimaryContactId));
 if (contact) {
   console.log(contact.id);  // already clean GUID
@@ -102,7 +102,7 @@ Xrm.WebApi.retrieveMultipleRecords("account",
   "?$select=name,revenue&$filter=statecode eq 0");
 
 // After: use Fields enum for $select
-import { select } from '@xrmforge/typegen';
+import { select } from '@xrmforge/typegen/helpers';
 import { AccountFields } from '../../typings/entities/account';
 Xrm.WebApi.retrieveMultipleRecords("account",
   `?$select=${select(AccountFields.Name, AccountFields.Revenue)}&$filter=statecode eq 0`);

package/dist/helpers.d.ts

@@ -0,0 +1,203 @@
+/**
+ * @xrmforge/typegen - Web API Helper Functions
+ *
+ * Lightweight utility functions for building OData query strings
+ * with type-safe field names from generated Fields enums.
+ *
+ * Zero runtime overhead when used with const enums (values are inlined).
+ *
+ * @example
+ * ```typescript
+ * import { select } from '@xrmforge/typegen';
+ *
+ * Xrm.WebApi.retrieveRecord(ref.entityType, ref.id, select(
+ *   AccountFields.Name,
+ *   AccountFields.WebsiteUrl,
+ *   AccountFields.Address1Line1,
+ * ));
+ * ```
+ */
+/**
+ * Build an OData $select query string from field names.
+ *
+ * @param fields - Field names (use generated Fields enum for type safety)
+ * @returns OData query string (e.g. "?$select=name,websiteurl,address1_line1")
+ */
+declare function select(...fields: string[]): string;
+/**
+ * Parse a lookup field from a Dataverse Web API response into a LookupValue.
+ *
+ * Dataverse returns lookups as `_fieldname_value` with OData annotations:
+ * - `_fieldname_value` (GUID)
+ * - `_fieldname_value@OData.Community.Display.V1.FormattedValue` (display name)
+ * - `_fieldname_value@Microsoft.Dynamics.CRM.lookuplogicalname` (entity type)
+ *
+ * This function extracts all three into an `Xrm.LookupValue` object.
+ *
+ * @param response - The raw Web API response object
+ * @param navigationProperty - Navigation property name (use NavigationProperties enum for type safety)
+ * @returns Xrm.LookupValue or null if the lookup is empty
+ *
+ * @example
+ * ```typescript
+ * // Mit NavigationProperties-Enum (empfohlen, keine Raw-Strings):
+ * parseLookup(result, AccountNav.Country);
+ *
+ * // Oder mit Navigation Property Name direkt:
+ * parseLookup(result, 'markant_address1_countryid');
+ * ```
+ */
+declare function parseLookup(response: Record<string, unknown>, navigationProperty: string): {
+    id: string;
+    name: string;
+    entityType: string;
+} | null;
+/**
+ * Parse multiple lookup fields from a Dataverse Web API response at once.
+ *
+ * @param response - The raw Web API response object
+ * @param navigationProperties - Navigation property names to parse
+ * @returns Map of navigation property name to LookupValue (null entries omitted)
+ *
+ * @example
+ * ```typescript
+ * const lookups = parseLookups(result, ['markant_address1_countryid', 'parentaccountid']);
+ * formContext.getAttribute(Fields.Country).setValue(
+ *   lookups.markant_address1_countryid ? [lookups.markant_address1_countryid] : null
+ * );
+ * ```
+ */
+declare function parseLookups(response: Record<string, unknown>, navigationProperties: string[]): Record<string, {
+    id: string;
+    name: string;
+    entityType: string;
+} | null>;
+/**
+ * Get the formatted (display) value of any field from a Web API response.
+ *
+ * Works for OptionSets, Lookups, DateTimes, Money, and other formatted fields.
+ *
+ * @param response - The raw Web API response object
+ * @param fieldName - The field logical name (e.g. "statecode", "createdon")
+ * @returns The formatted string value, or null if not available
+ *
+ * @example
+ * ```typescript
+ * const status = parseFormattedValue(result, 'statecode');
+ * // "Active" (statt 0)
+ * ```
+ */
+declare function parseFormattedValue(response: Record<string, unknown>, fieldName: string): string | null;
+/**
+ * Build an OData $select and $expand query string.
+ *
+ * @param fields - Field names to select
+ * @param expand - Navigation property to expand (optional)
+ * @returns OData query string
+ *
+ * @example
+ * ```typescript
+ * Xrm.WebApi.retrieveRecord("account", id, selectExpand(
+ *   [AccountFields.Name, AccountFields.WebsiteUrl],
+ *   "primarycontactid($select=fullname,emailaddress1)"
+ * ));
+ * ```
+ */
+declare function selectExpand(fields: string[], expand: string): string;
+
+/**
+ * @xrmforge/typegen - Xrm API Constants
+ *
+ * Const enums for all common Xrm string/number constants.
+ * Eliminates raw strings in D365 form scripts.
+ *
+ * @types/xrm defines these as string literal types for compile-time checking,
+ * but does NOT provide runtime constants (XrmEnum is not available at runtime).
+ * These const enums are erased at compile time (zero runtime overhead).
+ *
+ * @example
+ * ```typescript
+ * // Statt Raw-String:
+ * if (tab.getDisplayState() === 'expanded') { ... }
+ *
+ * // Mit XrmForge-Konstante:
+ * if (tab.getDisplayState() === XrmConstants.DisplayState.Expanded) { ... }
+ * ```
+ */
+/** Tab/Section display state */
+declare const enum DisplayState {
+    Expanded = "expanded",
+    Collapsed = "collapsed"
+}
+/** Form notification level (formContext.ui.setFormNotification) */
+declare const enum FormNotificationLevel {
+    Error = "ERROR",
+    Warning = "WARNING",
+    Info = "INFO"
+}
+/** Attribute required level (attribute.setRequiredLevel) */
+declare const enum RequiredLevel {
+    None = "none",
+    Required = "required",
+    Recommended = "recommended"
+}
+/** Attribute submit mode (attribute.setSubmitMode) */
+declare const enum SubmitMode {
+    Always = "always",
+    Never = "never",
+    Dirty = "dirty"
+}
+/** Save mode (eventArgs.getSaveMode()) */
+declare const enum SaveMode {
+    Save = 1,
+    SaveAndClose = 2,
+    Deactivate = 5,
+    Reactivate = 6,
+    Send = 7,
+    Disqualify = 15,
+    Qualify = 16,
+    Assign = 47,
+    SaveAsCompleted = 58,
+    SaveAndNew = 59,
+    AutoSave = 70
+}
+/** Client type (Xrm.Utility.getGlobalContext().client.getClient()) */
+declare const enum ClientType {
+    Web = "Web",
+    Outlook = "Outlook",
+    Mobile = "Mobile"
+}
+/** Client state (Xrm.Utility.getGlobalContext().client.getClientState()) */
+declare const enum ClientState {
+    Online = "Online",
+    Offline = "Offline"
+}
+/** Operation type for Xrm.WebApi.execute getMetadata().operationType */
+declare const enum OperationType {
+    /** Custom Action or OOB Action (POST) */
+    Action = 0,
+    /** Custom Function or OOB Function (GET) */
+    Function = 1,
+    /** CRUD operation (Create, Retrieve, Update, Delete) */
+    CRUD = 2
+}
+/** Structural property for getMetadata().parameterTypes[].structuralProperty */
+declare const enum StructuralProperty {
+    Unknown = 0,
+    PrimitiveType = 1,
+    ComplexType = 2,
+    EnumerationType = 3,
+    Collection = 4,
+    EntityType = 5
+}
+/** Binding type for Custom API definitions */
+declare const enum BindingType {
+    /** Nicht an eine Entity gebunden (global aufrufbar) */
+    Global = 0,
+    /** An einen einzelnen Entity-Datensatz gebunden */
+    Entity = 1,
+    /** An eine Entity-Collection gebunden */
+    EntityCollection = 2
+}
+
+export { BindingType, ClientState, ClientType, DisplayState, FormNotificationLevel, OperationType, RequiredLevel, SaveMode, StructuralProperty, SubmitMode, parseFormattedValue, parseLookup, parseLookups, select, selectExpand };

package/dist/helpers.js

@@ -0,0 +1,120 @@
+// src/generators/webapi-helpers.ts
+function select(...fields) {
+  if (fields.length === 0) return "";
+  return `?$select=${fields.join(",")}`;
+}
+function parseLookup(response, navigationProperty) {
+  const key = `_${navigationProperty}_value`;
+  const id = response[key];
+  if (!id) return null;
+  return {
+    id,
+    name: response[`${key}@OData.Community.Display.V1.FormattedValue`] ?? "",
+    entityType: response[`${key}@Microsoft.Dynamics.CRM.lookuplogicalname`] ?? ""
+  };
+}
+function parseLookups(response, navigationProperties) {
+  const result = {};
+  for (const prop of navigationProperties) {
+    result[prop] = parseLookup(response, prop);
+  }
+  return result;
+}
+function parseFormattedValue(response, fieldName) {
+  return response[`${fieldName}@OData.Community.Display.V1.FormattedValue`] ?? null;
+}
+function selectExpand(fields, expand) {
+  const parts = [];
+  if (fields.length > 0) parts.push(`$select=${fields.join(",")}`);
+  if (expand) parts.push(`$expand=${expand}`);
+  return parts.length > 0 ? `?${parts.join("&")}` : "";
+}
+
+// src/generators/xrm-constants.ts
+var DisplayState = /* @__PURE__ */ ((DisplayState2) => {
+  DisplayState2["Expanded"] = "expanded";
+  DisplayState2["Collapsed"] = "collapsed";
+  return DisplayState2;
+})(DisplayState || {});
+var FormNotificationLevel = /* @__PURE__ */ ((FormNotificationLevel2) => {
+  FormNotificationLevel2["Error"] = "ERROR";
+  FormNotificationLevel2["Warning"] = "WARNING";
+  FormNotificationLevel2["Info"] = "INFO";
+  return FormNotificationLevel2;
+})(FormNotificationLevel || {});
+var RequiredLevel = /* @__PURE__ */ ((RequiredLevel2) => {
+  RequiredLevel2["None"] = "none";
+  RequiredLevel2["Required"] = "required";
+  RequiredLevel2["Recommended"] = "recommended";
+  return RequiredLevel2;
+})(RequiredLevel || {});
+var SubmitMode = /* @__PURE__ */ ((SubmitMode2) => {
+  SubmitMode2["Always"] = "always";
+  SubmitMode2["Never"] = "never";
+  SubmitMode2["Dirty"] = "dirty";
+  return SubmitMode2;
+})(SubmitMode || {});
+var SaveMode = /* @__PURE__ */ ((SaveMode2) => {
+  SaveMode2[SaveMode2["Save"] = 1] = "Save";
+  SaveMode2[SaveMode2["SaveAndClose"] = 2] = "SaveAndClose";
+  SaveMode2[SaveMode2["Deactivate"] = 5] = "Deactivate";
+  SaveMode2[SaveMode2["Reactivate"] = 6] = "Reactivate";
+  SaveMode2[SaveMode2["Send"] = 7] = "Send";
+  SaveMode2[SaveMode2["Disqualify"] = 15] = "Disqualify";
+  SaveMode2[SaveMode2["Qualify"] = 16] = "Qualify";
+  SaveMode2[SaveMode2["Assign"] = 47] = "Assign";
+  SaveMode2[SaveMode2["SaveAsCompleted"] = 58] = "SaveAsCompleted";
+  SaveMode2[SaveMode2["SaveAndNew"] = 59] = "SaveAndNew";
+  SaveMode2[SaveMode2["AutoSave"] = 70] = "AutoSave";
+  return SaveMode2;
+})(SaveMode || {});
+var ClientType = /* @__PURE__ */ ((ClientType2) => {
+  ClientType2["Web"] = "Web";
+  ClientType2["Outlook"] = "Outlook";
+  ClientType2["Mobile"] = "Mobile";
+  return ClientType2;
+})(ClientType || {});
+var ClientState = /* @__PURE__ */ ((ClientState2) => {
+  ClientState2["Online"] = "Online";
+  ClientState2["Offline"] = "Offline";
+  return ClientState2;
+})(ClientState || {});
+var OperationType = /* @__PURE__ */ ((OperationType2) => {
+  OperationType2[OperationType2["Action"] = 0] = "Action";
+  OperationType2[OperationType2["Function"] = 1] = "Function";
+  OperationType2[OperationType2["CRUD"] = 2] = "CRUD";
+  return OperationType2;
+})(OperationType || {});
+var StructuralProperty = /* @__PURE__ */ ((StructuralProperty2) => {
+  StructuralProperty2[StructuralProperty2["Unknown"] = 0] = "Unknown";
+  StructuralProperty2[StructuralProperty2["PrimitiveType"] = 1] = "PrimitiveType";
+  StructuralProperty2[StructuralProperty2["ComplexType"] = 2] = "ComplexType";
+  StructuralProperty2[StructuralProperty2["EnumerationType"] = 3] = "EnumerationType";
+  StructuralProperty2[StructuralProperty2["Collection"] = 4] = "Collection";
+  StructuralProperty2[StructuralProperty2["EntityType"] = 5] = "EntityType";
+  return StructuralProperty2;
+})(StructuralProperty || {});
+var BindingType = /* @__PURE__ */ ((BindingType2) => {
+  BindingType2[BindingType2["Global"] = 0] = "Global";
+  BindingType2[BindingType2["Entity"] = 1] = "Entity";
+  BindingType2[BindingType2["EntityCollection"] = 2] = "EntityCollection";
+  return BindingType2;
+})(BindingType || {});
+export {
+  BindingType,
+  ClientState,
+  ClientType,
+  DisplayState,
+  FormNotificationLevel,
+  OperationType,
+  RequiredLevel,
+  SaveMode,
+  StructuralProperty,
+  SubmitMode,
+  parseFormattedValue,
+  parseLookup,
+  parseLookups,
+  select,
+  selectExpand
+};
+//# sourceMappingURL=helpers.js.map

package/dist/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/generators/webapi-helpers.ts","../src/generators/xrm-constants.ts"],"sourcesContent":["/**\r\n * @xrmforge/typegen - Web API Helper Functions\r\n *\r\n * Lightweight utility functions for building OData query strings\r\n * with type-safe field names from generated Fields enums.\r\n *\r\n * Zero runtime overhead when used with const enums (values are inlined).\r\n *\r\n * @example\r\n * ```typescript\r\n * import { select } from '@xrmforge/typegen';\r\n *\r\n * Xrm.WebApi.retrieveRecord(ref.entityType, ref.id, select(\r\n *   AccountFields.Name,\r\n *   AccountFields.WebsiteUrl,\r\n *   AccountFields.Address1Line1,\r\n * ));\r\n * ```\r\n */\r\n\r\n/**\r\n * Build an OData $select query string from field names.\r\n *\r\n * @param fields - Field names (use generated Fields enum for type safety)\r\n * @returns OData query string (e.g. \"?$select=name,websiteurl,address1_line1\")\r\n */\r\nexport function select(...fields: string[]): string {\r\n  if (fields.length === 0) return '';\r\n  return `?$select=${fields.join(',')}`;\r\n}\r\n\r\n/**\r\n * Parse a lookup field from a Dataverse Web API response into a LookupValue.\r\n *\r\n * Dataverse returns lookups as `_fieldname_value` with OData annotations:\r\n * - `_fieldname_value` (GUID)\r\n * - `_fieldname_value@OData.Community.Display.V1.FormattedValue` (display name)\r\n * - `_fieldname_value@Microsoft.Dynamics.CRM.lookuplogicalname` (entity type)\r\n *\r\n * This function extracts all three into an `Xrm.LookupValue` object.\r\n *\r\n * @param response - The raw Web API response object\r\n * @param navigationProperty - Navigation property name (use NavigationProperties enum for type safety)\r\n * @returns Xrm.LookupValue or null if the lookup is empty\r\n *\r\n * @example\r\n * ```typescript\r\n * // Mit NavigationProperties-Enum (empfohlen, keine Raw-Strings):\r\n * parseLookup(result, AccountNav.Country);\r\n *\r\n * // Oder mit Navigation Property Name direkt:\r\n * parseLookup(result, 'markant_address1_countryid');\r\n * ```\r\n */\r\nexport function parseLookup(\r\n  response: Record<string, unknown>,\r\n  navigationProperty: string,\r\n): { id: string; name: string; entityType: string } | null {\r\n  const key = `_${navigationProperty}_value`;\r\n  const id = response[key] as string | undefined;\r\n  if (!id) return null;\r\n\r\n  return {\r\n    id,\r\n    name: (response[`${key}@OData.Community.Display.V1.FormattedValue`] as string) ?? '',\r\n    entityType: (response[`${key}@Microsoft.Dynamics.CRM.lookuplogicalname`] as string) ?? '',\r\n  };\r\n}\r\n\r\n/**\r\n * Parse multiple lookup fields from a Dataverse Web API response at once.\r\n *\r\n * @param response - The raw Web API response object\r\n * @param navigationProperties - Navigation property names to parse\r\n * @returns Map of navigation property name to LookupValue (null entries omitted)\r\n *\r\n * @example\r\n * ```typescript\r\n * const lookups = parseLookups(result, ['markant_address1_countryid', 'parentaccountid']);\r\n * formContext.getAttribute(Fields.Country).setValue(\r\n *   lookups.markant_address1_countryid ? [lookups.markant_address1_countryid] : null\r\n * );\r\n * ```\r\n */\r\nexport function parseLookups(\r\n  response: Record<string, unknown>,\r\n  navigationProperties: string[],\r\n): Record<string, { id: string; name: string; entityType: string } | null> {\r\n  const result: Record<string, { id: string; name: string; entityType: string } | null> = {};\r\n  for (const prop of navigationProperties) {\r\n    result[prop] = parseLookup(response, prop);\r\n  }\r\n  return result;\r\n}\r\n\r\n/**\r\n * Get the formatted (display) value of any field from a Web API response.\r\n *\r\n * Works for OptionSets, Lookups, DateTimes, Money, and other formatted fields.\r\n *\r\n * @param response - The raw Web API response object\r\n * @param fieldName - The field logical name (e.g. \"statecode\", \"createdon\")\r\n * @returns The formatted string value, or null if not available\r\n *\r\n * @example\r\n * ```typescript\r\n * const status = parseFormattedValue(result, 'statecode');\r\n * // \"Active\" (statt 0)\r\n * ```\r\n */\r\nexport function parseFormattedValue(\r\n  response: Record<string, unknown>,\r\n  fieldName: string,\r\n): string | null {\r\n  return (response[`${fieldName}@OData.Community.Display.V1.FormattedValue`] as string) ?? null;\r\n}\r\n\r\n/**\r\n * Build an OData $select and $expand query string.\r\n *\r\n * @param fields - Field names to select\r\n * @param expand - Navigation property to expand (optional)\r\n * @returns OData query string\r\n *\r\n * @example\r\n * ```typescript\r\n * Xrm.WebApi.retrieveRecord(\"account\", id, selectExpand(\r\n *   [AccountFields.Name, AccountFields.WebsiteUrl],\r\n *   \"primarycontactid($select=fullname,emailaddress1)\"\r\n * ));\r\n * ```\r\n */\r\nexport function selectExpand(fields: string[], expand: string): string {\r\n  const parts: string[] = [];\r\n  if (fields.length > 0) parts.push(`$select=${fields.join(',')}`);\r\n  if (expand) parts.push(`$expand=${expand}`);\r\n  return parts.length > 0 ? `?${parts.join('&')}` : '';\r\n}\r\n","/**\r\n * @xrmforge/typegen - Xrm API Constants\r\n *\r\n * Const enums for all common Xrm string/number constants.\r\n * Eliminates raw strings in D365 form scripts.\r\n *\r\n * @types/xrm defines these as string literal types for compile-time checking,\r\n * but does NOT provide runtime constants (XrmEnum is not available at runtime).\r\n * These const enums are erased at compile time (zero runtime overhead).\r\n *\r\n * @example\r\n * ```typescript\r\n * // Statt Raw-String:\r\n * if (tab.getDisplayState() === 'expanded') { ... }\r\n *\r\n * // Mit XrmForge-Konstante:\r\n * if (tab.getDisplayState() === XrmConstants.DisplayState.Expanded) { ... }\r\n * ```\r\n */\r\n\r\n/** Tab/Section display state */\r\nexport const enum DisplayState {\r\n  Expanded = 'expanded',\r\n  Collapsed = 'collapsed',\r\n}\r\n\r\n// FormType: verwende XrmEnum.FormType aus @types/xrm (dort bereits als const enum definiert)\r\n\r\n/** Form notification level (formContext.ui.setFormNotification) */\r\nexport const enum FormNotificationLevel {\r\n  Error = 'ERROR',\r\n  Warning = 'WARNING',\r\n  Info = 'INFO',\r\n}\r\n\r\n/** Attribute required level (attribute.setRequiredLevel) */\r\nexport const enum RequiredLevel {\r\n  None = 'none',\r\n  Required = 'required',\r\n  Recommended = 'recommended',\r\n}\r\n\r\n/** Attribute submit mode (attribute.setSubmitMode) */\r\nexport const enum SubmitMode {\r\n  Always = 'always',\r\n  Never = 'never',\r\n  Dirty = 'dirty',\r\n}\r\n\r\n/** Save mode (eventArgs.getSaveMode()) */\r\nexport const enum SaveMode {\r\n  Save = 1,\r\n  SaveAndClose = 2,\r\n  Deactivate = 5,\r\n  Reactivate = 6,\r\n  Send = 7,\r\n  Disqualify = 15,\r\n  Qualify = 16,\r\n  Assign = 47,\r\n  SaveAsCompleted = 58,\r\n  SaveAndNew = 59,\r\n  AutoSave = 70,\r\n}\r\n\r\n/** Client type (Xrm.Utility.getGlobalContext().client.getClient()) */\r\nexport const enum ClientType {\r\n  Web = 'Web',\r\n  Outlook = 'Outlook',\r\n  Mobile = 'Mobile',\r\n}\r\n\r\n/** Client state (Xrm.Utility.getGlobalContext().client.getClientState()) */\r\nexport const enum ClientState {\r\n  Online = 'Online',\r\n  Offline = 'Offline',\r\n}\r\n\r\n// ─── WebApi Execute Constants ───────────────────────────────────────────────\r\n\r\n/** Operation type for Xrm.WebApi.execute getMetadata().operationType */\r\nexport const enum OperationType {\r\n  /** Custom Action or OOB Action (POST) */\r\n  Action = 0,\r\n  /** Custom Function or OOB Function (GET) */\r\n  Function = 1,\r\n  /** CRUD operation (Create, Retrieve, Update, Delete) */\r\n  CRUD = 2,\r\n}\r\n\r\n/** Structural property for getMetadata().parameterTypes[].structuralProperty */\r\nexport const enum StructuralProperty {\r\n  Unknown = 0,\r\n  PrimitiveType = 1,\r\n  ComplexType = 2,\r\n  EnumerationType = 3,\r\n  Collection = 4,\r\n  EntityType = 5,\r\n}\r\n\r\n/** Binding type for Custom API definitions */\r\nexport const enum BindingType {\r\n  /** Nicht an eine Entity gebunden (global aufrufbar) */\r\n  Global = 0,\r\n  /** An einen einzelnen Entity-Datensatz gebunden */\r\n  Entity = 1,\r\n  /** An eine Entity-Collection gebunden */\r\n  EntityCollection = 2,\r\n}\r\n"],"mappings":";AA0BO,SAAS,UAAU,QAA0B;AAClD,MAAI,OAAO,WAAW,EAAG,QAAO;AAChC,SAAO,YAAY,OAAO,KAAK,GAAG,CAAC;AACrC;AAyBO,SAAS,YACd,UACA,oBACyD;AACzD,QAAM,MAAM,IAAI,kBAAkB;AAClC,QAAM,KAAK,SAAS,GAAG;AACvB,MAAI,CAAC,GAAI,QAAO;AAEhB,SAAO;AAAA,IACL;AAAA,IACA,MAAO,SAAS,GAAG,GAAG,4CAA4C,KAAgB;AAAA,IAClF,YAAa,SAAS,GAAG,GAAG,2CAA2C,KAAgB;AAAA,EACzF;AACF;AAiBO,SAAS,aACd,UACA,sBACyE;AACzE,QAAM,SAAkF,CAAC;AACzF,aAAW,QAAQ,sBAAsB;AACvC,WAAO,IAAI,IAAI,YAAY,UAAU,IAAI;AAAA,EAC3C;AACA,SAAO;AACT;AAiBO,SAAS,oBACd,UACA,WACe;AACf,SAAQ,SAAS,GAAG,SAAS,4CAA4C,KAAgB;AAC3F;AAiBO,SAAS,aAAa,QAAkB,QAAwB;AACrE,QAAM,QAAkB,CAAC;AACzB,MAAI,OAAO,SAAS,EAAG,OAAM,KAAK,WAAW,OAAO,KAAK,GAAG,CAAC,EAAE;AAC/D,MAAI,OAAQ,OAAM,KAAK,WAAW,MAAM,EAAE;AAC1C,SAAO,MAAM,SAAS,IAAI,IAAI,MAAM,KAAK,GAAG,CAAC,KAAK;AACpD;;;ACpHO,IAAW,eAAX,kBAAWA,kBAAX;AACL,EAAAA,cAAA,cAAW;AACX,EAAAA,cAAA,eAAY;AAFI,SAAAA;AAAA,GAAA;AAQX,IAAW,wBAAX,kBAAWC,2BAAX;AACL,EAAAA,uBAAA,WAAQ;AACR,EAAAA,uBAAA,aAAU;AACV,EAAAA,uBAAA,UAAO;AAHS,SAAAA;AAAA,GAAA;AAOX,IAAW,gBAAX,kBAAWC,mBAAX;AACL,EAAAA,eAAA,UAAO;AACP,EAAAA,eAAA,cAAW;AACX,EAAAA,eAAA,iBAAc;AAHE,SAAAA;AAAA,GAAA;AAOX,IAAW,aAAX,kBAAWC,gBAAX;AACL,EAAAA,YAAA,YAAS;AACT,EAAAA,YAAA,WAAQ;AACR,EAAAA,YAAA,WAAQ;AAHQ,SAAAA;AAAA,GAAA;AAOX,IAAW,WAAX,kBAAWC,cAAX;AACL,EAAAA,oBAAA,UAAO,KAAP;AACA,EAAAA,oBAAA,kBAAe,KAAf;AACA,EAAAA,oBAAA,gBAAa,KAAb;AACA,EAAAA,oBAAA,gBAAa,KAAb;AACA,EAAAA,oBAAA,UAAO,KAAP;AACA,EAAAA,oBAAA,gBAAa,MAAb;AACA,EAAAA,oBAAA,aAAU,MAAV;AACA,EAAAA,oBAAA,YAAS,MAAT;AACA,EAAAA,oBAAA,qBAAkB,MAAlB;AACA,EAAAA,oBAAA,gBAAa,MAAb;AACA,EAAAA,oBAAA,cAAW,MAAX;AAXgB,SAAAA;AAAA,GAAA;AAeX,IAAW,aAAX,kBAAWC,gBAAX;AACL,EAAAA,YAAA,SAAM;AACN,EAAAA,YAAA,aAAU;AACV,EAAAA,YAAA,YAAS;AAHO,SAAAA;AAAA,GAAA;AAOX,IAAW,cAAX,kBAAWC,iBAAX;AACL,EAAAA,aAAA,YAAS;AACT,EAAAA,aAAA,aAAU;AAFM,SAAAA;AAAA,GAAA;AAQX,IAAW,gBAAX,kBAAWC,mBAAX;AAEL,EAAAA,8BAAA,YAAS,KAAT;AAEA,EAAAA,8BAAA,cAAW,KAAX;AAEA,EAAAA,8BAAA,UAAO,KAAP;AANgB,SAAAA;AAAA,GAAA;AAUX,IAAW,qBAAX,kBAAWC,wBAAX;AACL,EAAAA,wCAAA,aAAU,KAAV;AACA,EAAAA,wCAAA,mBAAgB,KAAhB;AACA,EAAAA,wCAAA,iBAAc,KAAd;AACA,EAAAA,wCAAA,qBAAkB,KAAlB;AACA,EAAAA,wCAAA,gBAAa,KAAb;AACA,EAAAA,wCAAA,gBAAa,KAAb;AANgB,SAAAA;AAAA,GAAA;AAUX,IAAW,cAAX,kBAAWC,iBAAX;AAEL,EAAAA,0BAAA,YAAS,KAAT;AAEA,EAAAA,0BAAA,YAAS,KAAT;AAEA,EAAAA,0BAAA,sBAAmB,KAAnB;AANgB,SAAAA;AAAA,GAAA;","names":["DisplayState","FormNotificationLevel","RequiredLevel","SubmitMode","SaveMode","ClientType","ClientState","OperationType","StructuralProperty","BindingType"]}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { TokenCredential } from '@azure/identity';
+export { BindingType, ClientState, ClientType, DisplayState, FormNotificationLevel, OperationType, RequiredLevel, SaveMode, StructuralProperty, SubmitMode, parseFormattedValue, parseLookup, parseLookups, select, selectExpand } from './helpers.js';
 
 /**
  * @xrmforge/typegen - Error Types
@@ -1451,208 +1452,6 @@ interface EntityNamesGeneratorOptions {
  */
 declare function generateEntityNamesEnum(entityNames: string[], options?: EntityNamesGeneratorOptions): string;
 
-/**
- * @xrmforge/typegen - Web API Helper Functions
- *
- * Lightweight utility functions for building OData query strings
- * with type-safe field names from generated Fields enums.
- *
- * Zero runtime overhead when used with const enums (values are inlined).
- *
- * @example
- * ```typescript
- * import { select } from '@xrmforge/typegen';
- *
- * Xrm.WebApi.retrieveRecord(ref.entityType, ref.id, select(
- *   AccountFields.Name,
- *   AccountFields.WebsiteUrl,
- *   AccountFields.Address1Line1,
- * ));
- * ```
- */
-/**
- * Build an OData $select query string from field names.
- *
- * @param fields - Field names (use generated Fields enum for type safety)
- * @returns OData query string (e.g. "?$select=name,websiteurl,address1_line1")
- */
-declare function select(...fields: string[]): string;
-/**
- * Parse a lookup field from a Dataverse Web API response into a LookupValue.
- *
- * Dataverse returns lookups as `_fieldname_value` with OData annotations:
- * - `_fieldname_value` (GUID)
- * - `_fieldname_value@OData.Community.Display.V1.FormattedValue` (display name)
- * - `_fieldname_value@Microsoft.Dynamics.CRM.lookuplogicalname` (entity type)
- *
- * This function extracts all three into an `Xrm.LookupValue` object.
- *
- * @param response - The raw Web API response object
- * @param navigationProperty - Navigation property name (use NavigationProperties enum for type safety)
- * @returns Xrm.LookupValue or null if the lookup is empty
- *
- * @example
- * ```typescript
- * // Mit NavigationProperties-Enum (empfohlen, keine Raw-Strings):
- * parseLookup(result, AccountNav.Country);
- *
- * // Oder mit Navigation Property Name direkt:
- * parseLookup(result, 'markant_address1_countryid');
- * ```
- */
-declare function parseLookup(response: Record<string, unknown>, navigationProperty: string): {
-    id: string;
-    name: string;
-    entityType: string;
-} | null;
-/**
- * Parse multiple lookup fields from a Dataverse Web API response at once.
- *
- * @param response - The raw Web API response object
- * @param navigationProperties - Navigation property names to parse
- * @returns Map of navigation property name to LookupValue (null entries omitted)
- *
- * @example
- * ```typescript
- * const lookups = parseLookups(result, ['markant_address1_countryid', 'parentaccountid']);
- * formContext.getAttribute(Fields.Country).setValue(
- *   lookups.markant_address1_countryid ? [lookups.markant_address1_countryid] : null
- * );
- * ```
- */
-declare function parseLookups(response: Record<string, unknown>, navigationProperties: string[]): Record<string, {
-    id: string;
-    name: string;
-    entityType: string;
-} | null>;
-/**
- * Get the formatted (display) value of any field from a Web API response.
- *
- * Works for OptionSets, Lookups, DateTimes, Money, and other formatted fields.
- *
- * @param response - The raw Web API response object
- * @param fieldName - The field logical name (e.g. "statecode", "createdon")
- * @returns The formatted string value, or null if not available
- *
- * @example
- * ```typescript
- * const status = parseFormattedValue(result, 'statecode');
- * // "Active" (statt 0)
- * ```
- */
-declare function parseFormattedValue(response: Record<string, unknown>, fieldName: string): string | null;
-/**
- * Build an OData $select and $expand query string.
- *
- * @param fields - Field names to select
- * @param expand - Navigation property to expand (optional)
- * @returns OData query string
- *
- * @example
- * ```typescript
- * Xrm.WebApi.retrieveRecord("account", id, selectExpand(
- *   [AccountFields.Name, AccountFields.WebsiteUrl],
- *   "primarycontactid($select=fullname,emailaddress1)"
- * ));
- * ```
- */
-declare function selectExpand(fields: string[], expand: string): string;
-
-/**
- * @xrmforge/typegen - Xrm API Constants
- *
- * Const enums for all common Xrm string/number constants.
- * Eliminates raw strings in D365 form scripts.
- *
- * @types/xrm defines these as string literal types for compile-time checking,
- * but does NOT provide runtime constants (XrmEnum is not available at runtime).
- * These const enums are erased at compile time (zero runtime overhead).
- *
- * @example
- * ```typescript
- * // Statt Raw-String:
- * if (tab.getDisplayState() === 'expanded') { ... }
- *
- * // Mit XrmForge-Konstante:
- * if (tab.getDisplayState() === XrmConstants.DisplayState.Expanded) { ... }
- * ```
- */
-/** Tab/Section display state */
-declare const enum DisplayState {
-    Expanded = "expanded",
-    Collapsed = "collapsed"
-}
-/** Form notification level (formContext.ui.setFormNotification) */
-declare const enum FormNotificationLevel {
-    Error = "ERROR",
-    Warning = "WARNING",
-    Info = "INFO"
-}
-/** Attribute required level (attribute.setRequiredLevel) */
-declare const enum RequiredLevel {
-    None = "none",
-    Required = "required",
-    Recommended = "recommended"
-}
-/** Attribute submit mode (attribute.setSubmitMode) */
-declare const enum SubmitMode {
-    Always = "always",
-    Never = "never",
-    Dirty = "dirty"
-}
-/** Save mode (eventArgs.getSaveMode()) */
-declare const enum SaveMode {
-    Save = 1,
-    SaveAndClose = 2,
-    Deactivate = 5,
-    Reactivate = 6,
-    Send = 7,
-    Disqualify = 15,
-    Qualify = 16,
-    Assign = 47,
-    SaveAsCompleted = 58,
-    SaveAndNew = 59,
-    AutoSave = 70
-}
-/** Client type (Xrm.Utility.getGlobalContext().client.getClient()) */
-declare const enum ClientType {
-    Web = "Web",
-    Outlook = "Outlook",
-    Mobile = "Mobile"
-}
-/** Client state (Xrm.Utility.getGlobalContext().client.getClientState()) */
-declare const enum ClientState {
-    Online = "Online",
-    Offline = "Offline"
-}
-/** Operation type for Xrm.WebApi.execute getMetadata().operationType */
-declare const enum OperationType {
-    /** Custom Action or OOB Action (POST) */
-    Action = 0,
-    /** Custom Function or OOB Function (GET) */
-    Function = 1,
-    /** CRUD operation (Create, Retrieve, Update, Delete) */
-    CRUD = 2
-}
-/** Structural property for getMetadata().parameterTypes[].structuralProperty */
-declare const enum StructuralProperty {
-    Unknown = 0,
-    PrimitiveType = 1,
-    ComplexType = 2,
-    EnumerationType = 3,
-    Collection = 4,
-    EntityType = 5
-}
-/** Binding type for Custom API definitions */
-declare const enum BindingType {
-    /** Nicht an eine Entity gebunden (global aufrufbar) */
-    Global = 0,
-    /** An einen einzelnen Entity-Datensatz gebunden */
-    Entity = 1,
-    /** An eine Entity-Collection gebunden */
-    EntityCollection = 2
-}
-
 /**
  * @xrmforge/typegen - Action/Function Runtime Helpers
  *
@@ -2001,4 +1800,4 @@ declare class TypeGenerationOrchestrator {
     private getPicklistAttributes;
 }
 
-export { type ActionGeneratorOptions, ApiRequestError, type AttributeMetadata, type AuthConfig, type AuthMethod, AuthenticationError, BindingType, type BoundActionExecutor, type BoundActionWithParamsExecutor, type BoundFunctionExecutor, type CacheStats, type ChangeDetectionResult, ChangeDetector, type ClientCredentialsAuth, ClientState, ClientType, ConfigError, ConsoleLogSink, type CustomApiTypeInfo, DEFAULT_LABEL_CONFIG, DataverseHttpClient, type DateTimeAttributeMetadata, type DecimalAttributeMetadata, type DeviceCodeAuth, DisplayState, type EntityFieldsGeneratorOptions, type EntityGenerationResult, type EntityGeneratorOptions, type EntityMetadata, type EntityNamesGeneratorOptions, type EntityTypeInfo, ErrorCode, FastXmlParser, type FormControl, type FormGeneratorOptions, FormNotificationLevel, type FormSection, type FormTab, type GenerateConfig, type GeneratedFile, GenerationError, type GenerationResult, type GroupedCustomApis, type HttpClientOptions, type IntegerAttributeMetadata, type InteractiveAuth, JsonLogSink, type Label, type LabelConfig, type LocalizedLabel, type LogEntry, LogLevel, type LogSink, Logger, type LookupAttributeMetadata, type ManyToManyRelationshipMetadata, MetadataCache, MetadataClient, MetadataError, type MoneyAttributeMetadata, type OneToManyRelationshipMetadata, OperationType, type OptionMetadata, type OptionSetGeneratorOptions, type OptionSetMetadata, type ParameterMeta, type ParameterMetaMap, type ParsedForm, type PicklistAttributeMetadata, RequiredLevel, SaveMode, SilentLogSink, type SolutionComponent, type StateAttributeMetadata, type StatusAttributeMetadata, type StringAttributeMetadata, StructuralProperty, SubmitMode, type SystemFormMetadata, TypeGenerationOrchestrator, type UnboundActionExecutor, type UnboundActionWithParamsExecutor, type UnboundFunctionExecutor, type XmlElement, type XmlParser, XrmForgeError, configureLogging, createBoundAction, createBoundFunction, createCredential, createLogger, createUnboundAction, createUnboundFunction, defaultXmlParser, disambiguateEnumMembers, executeMultiple, executeRequest, extractControlFields, getJSDocLabel as formatDualLabel, generateActionDeclarations, generateActionModule, generateActivityPartyInterface, generateEntityFieldsEnum, generateEntityForms, generateEntityInterface, generateEntityNamesEnum, generateEntityNavigationProperties, generateEntityOptionSets, generateEnumMembers, generateFormInterface, generateOptionSetEnum, getEntityPropertyType, getFormAttributeType, getFormControlType, getFormMockValueType, getJSDocLabel, getLabelLanguagesParam, getPrimaryLabel, getSecondaryLabel, groupCustomApis, isLookupType, isPartyListType, isRateLimitError, isXrmForgeError, labelToIdentifier, parseForm, parseFormattedValue, parseLookup, parseLookups, select, selectExpand, shouldIncludeInEntityInterface, toLookupValueProperty, toPascalCase, toSafeIdentifier, withProgress };
+export { type ActionGeneratorOptions, ApiRequestError, type AttributeMetadata, type AuthConfig, type AuthMethod, AuthenticationError, type BoundActionExecutor, type BoundActionWithParamsExecutor, type BoundFunctionExecutor, type CacheStats, type ChangeDetectionResult, ChangeDetector, type ClientCredentialsAuth, ConfigError, ConsoleLogSink, type CustomApiTypeInfo, DEFAULT_LABEL_CONFIG, DataverseHttpClient, type DateTimeAttributeMetadata, type DecimalAttributeMetadata, type DeviceCodeAuth, type EntityFieldsGeneratorOptions, type EntityGenerationResult, type EntityGeneratorOptions, type EntityMetadata, type EntityNamesGeneratorOptions, type EntityTypeInfo, ErrorCode, FastXmlParser, type FormControl, type FormGeneratorOptions, type FormSection, type FormTab, type GenerateConfig, type GeneratedFile, GenerationError, type GenerationResult, type GroupedCustomApis, type HttpClientOptions, type IntegerAttributeMetadata, type InteractiveAuth, JsonLogSink, type Label, type LabelConfig, type LocalizedLabel, type LogEntry, LogLevel, type LogSink, Logger, type LookupAttributeMetadata, type ManyToManyRelationshipMetadata, MetadataCache, MetadataClient, MetadataError, type MoneyAttributeMetadata, type OneToManyRelationshipMetadata, type OptionMetadata, type OptionSetGeneratorOptions, type OptionSetMetadata, type ParameterMeta, type ParameterMetaMap, type ParsedForm, type PicklistAttributeMetadata, SilentLogSink, type SolutionComponent, type StateAttributeMetadata, type StatusAttributeMetadata, type StringAttributeMetadata, type SystemFormMetadata, TypeGenerationOrchestrator, type UnboundActionExecutor, type UnboundActionWithParamsExecutor, type UnboundFunctionExecutor, type XmlElement, type XmlParser, XrmForgeError, configureLogging, createBoundAction, createBoundFunction, createCredential, createLogger, createUnboundAction, createUnboundFunction, defaultXmlParser, disambiguateEnumMembers, executeMultiple, executeRequest, extractControlFields, getJSDocLabel as formatDualLabel, generateActionDeclarations, generateActionModule, generateActivityPartyInterface, generateEntityFieldsEnum, generateEntityForms, generateEntityInterface, generateEntityNamesEnum, generateEntityNavigationProperties, generateEntityOptionSets, generateEnumMembers, generateFormInterface, generateOptionSetEnum, getEntityPropertyType, getFormAttributeType, getFormControlType, getFormMockValueType, getJSDocLabel, getLabelLanguagesParam, getPrimaryLabel, getSecondaryLabel, groupCustomApis, isLookupType, isPartyListType, isRateLimitError, isXrmForgeError, labelToIdentifier, parseForm, shouldIncludeInEntityInterface, toLookupValueProperty, toPascalCase, toSafeIdentifier, withProgress };

package/package.json

@@ -1,65 +1,70 @@
-{
-  "name": "@xrmforge/typegen",
-  "version": "0.5.1",
-  "description": "TypeScript declaration generator for Dynamics 365 / Dataverse",
-  "keywords": [
-    "dynamics-365",
-    "typescript",
-    "xrm",
-    "dataverse",
-    "type-generator",
-    "declaration-files"
-  ],
-  "license": "MIT",
-  "author": "XrmForge Contributors",
-  "homepage": "https://github.com/juergenbeck/XrmForge/tree/main/packages/typegen",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/juergenbeck/XrmForge.git",
-    "directory": "packages/typegen"
-  },
-  "bugs": {
-    "url": "https://github.com/juergenbeck/XrmForge/issues"
-  },
-  "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "default": "./dist/index.js"
-    }
-  },
-  "files": [
-    "dist",
-    "MIGRATION.md"
-  ],
-  "sideEffects": false,
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "typecheck": "tsc --noEmit",
-    "lint": "eslint src/",
-    "clean": "rm -rf dist"
-  },
-  "dependencies": {
-    "@azure/identity": "^4.6.0",
-    "fast-xml-parser": "^5.5.9"
-  },
-  "devDependencies": {
-    "@types/node": "^22.0.0",
-    "@vitest/coverage-v8": "^3.2.4",
-    "tsup": "^8.3.0",
-    "typescript": "^5.7.0",
-    "vitest": "^3.0.0"
-  },
-  "peerDependencies": {
-    "@types/xrm": ">=9.0.0"
-  },
-  "engines": {
-    "node": ">=20.0.0"
-  }
-}
+{
+  "name": "@xrmforge/typegen",
+  "version": "0.6.0",
+  "description": "TypeScript declaration generator for Dynamics 365 / Dataverse",
+  "keywords": [
+    "dynamics-365",
+    "typescript",
+    "xrm",
+    "dataverse",
+    "type-generator",
+    "declaration-files"
+  ],
+  "license": "MIT",
+  "author": "XrmForge Contributors",
+  "homepage": "https://github.com/juergenbeck/XrmForge/tree/main/packages/typegen",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/juergenbeck/XrmForge.git",
+    "directory": "packages/typegen"
+  },
+  "bugs": {
+    "url": "https://github.com/juergenbeck/XrmForge/issues"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./helpers": {
+      "types": "./dist/helpers.d.ts",
+      "import": "./dist/helpers.js",
+      "default": "./dist/helpers.js"
+    }
+  },
+  "files": [
+    "dist",
+    "MIGRATION.md"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@azure/identity": "^4.6.0",
+    "fast-xml-parser": "^5.5.9"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@vitest/coverage-v8": "^3.2.4",
+    "tsup": "^8.3.0",
+    "typescript": "^5.7.0",
+    "vitest": "^3.0.0"
+  },
+  "peerDependencies": {
+    "@types/xrm": ">=9.0.0"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src/",
+    "clean": "rm -rf dist"
+  }
+}