@xrmforge/typegen 0.8.0 → 0.8.2

package/dist/index.d.ts

@@ -1440,345 +1440,12 @@ 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
- *
- * Factory functions for type-safe Custom API execution.
- * These are imported by generated action/function modules.
- *
- * Design:
- * - `createBoundAction` / `createUnboundAction`: Produce executor objects
- *   with `.execute()` (calls Xrm.WebApi) and `.request()` (for executeMultiple)
- * - `executeRequest`: Central execute wrapper (single place for the `as any` cast)
- * - `withProgress`: Convenience wrapper with progress indicator + error dialog
- *
- * @example
- * ```typescript
- * // Generated code (in generated/actions/quote.ts):
- * export const WinQuote = createBoundAction('markant_winquote', 'quote');
- *
- * // Developer code (in quote-form.ts):
- * import { WinQuote } from '../generated/actions/quote';
- * const response = await WinQuote.execute(recordId);
- * ```
- */
-/** Parameter metadata for getMetadata().parameterTypes */
-interface ParameterMeta {
-    typeName: string;
-    structuralProperty: number;
-}
-/** Map of parameter names to their OData metadata */
-type ParameterMetaMap = Record<string, ParameterMeta>;
-/** Executor for a bound action without additional parameters */
-interface BoundActionExecutor {
-    execute(recordId: string): Promise<Response>;
-    request(recordId: string): Record<string, unknown>;
-}
-/** Executor for a bound action with typed parameters */
-interface BoundActionWithParamsExecutor<TParams> {
-    execute(recordId: string, params: TParams): Promise<Response>;
-    request(recordId: string, params: TParams): Record<string, unknown>;
-}
-/** Executor for an unbound action without parameters */
-interface UnboundActionExecutor {
-    execute(): Promise<Response>;
-    request(): Record<string, unknown>;
-}
-/** Executor for an unbound action with typed parameters and optional typed response */
-interface UnboundActionWithParamsExecutor<TParams, TResult = void> {
-    execute(params: TParams): Promise<TResult extends void ? Response : TResult>;
-    request(params: TParams): Record<string, unknown>;
-}
-/** Executor for an unbound function with typed response */
-interface UnboundFunctionExecutor<TResult> {
-    execute(): Promise<TResult>;
-    request(): Record<string, unknown>;
-}
-/** Executor for a bound function with typed response */
-interface BoundFunctionExecutor<TResult> {
-    execute(recordId: string): Promise<TResult>;
-    request(recordId: string): Record<string, unknown>;
-}
-/**
- * Execute a single request via Xrm.WebApi.online.execute().
- *
- * This is the ONLY place in the entire framework where the `as any` cast happens.
- * All generated executors call this function internally.
- */
-declare function executeRequest(request: Record<string, unknown>): Promise<Response>;
-/**
- * Execute multiple requests via Xrm.WebApi.online.executeMultiple().
- *
- * @param requests - Array of request objects (from `.request()` factories).
- *   Wrap a subset in an inner array for transactional changeset execution.
- */
-declare function executeMultiple(requests: Array<Record<string, unknown> | Array<Record<string, unknown>>>): Promise<Response[]>;
-/**
- * Create an executor for a bound action (entity-bound).
- *
- * @param operationName - Custom API unique name (e.g. "markant_winquote")
- * @param entityLogicalName - Entity logical name (e.g. "quote")
- */
-declare function createBoundAction(operationName: string, entityLogicalName: string): BoundActionExecutor;
-/**
- * Create an executor for a bound action with typed parameters.
- *
- * @param operationName - Custom API unique name
- * @param entityLogicalName - Entity logical name
- * @param paramMeta - Parameter metadata map (parameter name to OData type info)
- */
-declare function createBoundAction<TParams extends Record<string, unknown>>(operationName: string, entityLogicalName: string, paramMeta: ParameterMetaMap): BoundActionWithParamsExecutor<TParams>;
-/**
- * Create an executor for an unbound (global) action without parameters.
- *
- * @param operationName - Custom API unique name
- */
-declare function createUnboundAction(operationName: string): UnboundActionExecutor;
-/**
- * Create an executor for an unbound action with typed parameters and response.
- *
- * @param operationName - Custom API unique name
- * @param paramMeta - Parameter metadata map
- */
-declare function createUnboundAction<TParams extends Record<string, unknown>, TResult = void>(operationName: string, paramMeta: ParameterMetaMap): UnboundActionWithParamsExecutor<TParams, TResult>;
-/**
- * Create an executor for an unbound (global) function with typed response.
- *
- * @param operationName - Function name (e.g. "WhoAmI")
- */
-declare function createUnboundFunction<TResult>(operationName: string): UnboundFunctionExecutor<TResult>;
-/**
- * Create an executor for a bound function with typed response.
- *
- * @param operationName - Function name
- * @param entityLogicalName - Entity logical name
- */
-declare function createBoundFunction<TResult>(operationName: string, entityLogicalName: string): BoundFunctionExecutor<TResult>;
-/**
- * Execute an async operation with Xrm progress indicator.
- *
- * Shows a progress spinner before the operation, closes it after,
- * and shows an error dialog on failure.
- *
- * @param message - Progress indicator message (e.g. "Angebot wird gewonnen...")
- * @param operation - Async function to execute
- * @returns The result of the operation
- *
- * @example
- * ```typescript
- * await withProgress('Angebot wird gewonnen...', () => WinQuote.execute(recordId));
- * ```
- */
-declare function withProgress<T>(message: string, operation: () => Promise<T>): Promise<T>;
-
 /**
  * @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/typegen
+ * - .ts: Runtime modules that import factory functions from @xrmforge/helpers
  *
  * Input: CustomApiTypeInfo[] (from fixture JSON or live Dataverse query)
  * Output: Grouped by entity (bound) or "global" (unbound)
@@ -1792,7 +1459,7 @@ declare function withProgress<T>(message: string, operation: () => Promise<T>):
  * }
  *
  * // global.ts
- * import { createUnboundAction } from '@xrmforge/typegen';
+ * import { createUnboundAction } from '@xrmforge/helpers';
  * export const NormalizePhone = createUnboundAction<...>('markant_NormalizePhone', { ... });
  * ```
  */
@@ -1989,4 +1656,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 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 ParsedForm, type PicklistAttributeMetadata, SilentLogSink, type SolutionComponent, type StateAttributeMetadata, type StatusAttributeMetadata, type StringAttributeMetadata, type SystemFormMetadata, TypeGenerationOrchestrator, type XmlElement, type XmlParser, XrmForgeError, configureLogging, createCredential, createLogger, defaultXmlParser, disambiguateEnumMembers, 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 };