@limetech/lime-crm-building-blocks 1.101.0 → 1.102.0

package/dist/types/components/lime-query-builder/lime-query-response-format-builder.d.ts

@@ -0,0 +1,102 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { LimeWebComponent, LimeWebComponentContext, LimeWebComponentPlatform } from '@limetech/lime-web-components';
+import { ResponseFormat } from './lime-query.types';
+/**
+ * Response Format Builder
+ *
+ * A focused component for editing Lime Query ResponseFormat in isolation.
+ * Supports both GUI and code modes for maximum flexibility.
+ *
+ * Use this component when you need to configure which properties to return
+ * from a query, but don't need filter, limit, or other query parameters.
+ *
+ * **Features**:
+ * - **GUI Mode**: Visual property selector with relation navigation
+ * - **Code Mode**: JSON editor for ResponseFormat structure
+ * - **Validation**: Ensures JSON is valid ResponseFormat (rejects other fields)
+ * - **Mode Toggle**: Switch between GUI and code modes seamlessly
+ * - **Feature Flag**: Respects `useLimeQueryBuilderGuiMode` setting
+ *
+ * @example
+ * ```tsx
+ * <limebb-lime-query-response-format-builder
+ *     platform={this.platform}
+ *     context={this.context}
+ *     limetype="deal"
+ *     value={this.responseFormat}
+ *     label="Select Properties to Return"
+ *     onChange={this.handleChange}
+ * />
+ * ```
+ *
+ * @exampleComponent limebb-example-response-format-builder-basic
+ * @private
+ */
+export declare class LimeQueryResponseFormatBuilder implements LimeWebComponent {
+    /**
+     * Platform service provider
+     */
+    platform: LimeWebComponentPlatform;
+    /**
+     * Component context
+     */
+    context: LimeWebComponentContext;
+    /**
+     * The limetype to configure response format for
+     * This is fixed and not editable by the user
+     */
+    limetype: string;
+    /**
+     * Current response format value
+     */
+    value?: ResponseFormat;
+    /**
+     * Optional label for the builder
+     */
+    label: string;
+    /**
+     * Emitted when the response format changes
+     */
+    change: EventEmitter<ResponseFormat>;
+    private limetypes;
+    private mode;
+    private codeValue;
+    private internalValue;
+    /**
+     * Check if GUI mode is enabled via feature flag
+     */
+    private get guiModeEnabled();
+    componentWillLoad(): void;
+    componentWillUpdate(): void;
+    render(): any;
+    private renderModeSwitch;
+    private renderCodeEditor;
+    private renderGuiMode;
+    /**
+     * Check if current value can be rendered in GUI mode
+     */
+    private checkGuiSupport;
+    /**
+     * Update code value from internal state
+     */
+    private updateCodeValue;
+    /**
+     * Switch from code mode to GUI mode
+     */
+    private switchToGui;
+    /**
+     * Switch from GUI mode to code mode
+     */
+    private switchToCode;
+    /**
+     * Handle code editor changes
+     * @param event
+     */
+    private handleCodeChange;
+    /**
+     * Handle GUI mode changes
+     * @param event
+     */
+    private handleGuiChange;
+}
+//# sourceMappingURL=lime-query-response-format-builder.d.ts.map

package/dist/types/components/lime-query-builder/lime-query-validation.d.ts

@@ -55,4 +55,17 @@ export declare function validatePropertySelection(selection: PropertySelection,
  * @returns LimeQueryValidationResult with validity status and any errors/limitations
  */
 export declare function isLimeQuerySupported(limeQuery: LimeQuery, limetypes: Record<string, LimeType>, activeLimetype?: string, guiModeEnabled?: boolean): LimeQueryValidationResult;
+/**
+ * Validate a ResponseFormat in isolation (for response-format-builder)
+ *
+ * This validator is designed for the response-format-builder component,
+ * which only handles ResponseFormat editing without the full LimeQuery context.
+ *
+ * @param responseFormat - The response format to validate
+ * @param limetypes - Record of all available limetypes
+ * @param limetype - The limetype context for validation
+ * @param guiModeEnabled - Whether GUI mode is enabled (affects validation)
+ * @returns Validation result with errors and GUI limitations
+ */
+export declare function validateResponseFormatOnly(responseFormat: ResponseFormat, limetypes: Record<string, LimeType>, limetype: string, guiModeEnabled?: boolean): LimeQueryValidationResult;
 //# sourceMappingURL=lime-query-validation.d.ts.map

package/dist/types/components/lime-query-builder/{response-format-editor.d.ts → response-format/response-format-editor.d.ts}

@@ -1,6 +1,6 @@
-import { EventEmitter } from '../../stencil-public-runtime';
+import { EventEmitter } from '../../../stencil-public-runtime';
 import { LimeWebComponent, LimeWebComponentContext, LimeWebComponentPlatform } from '@limetech/lime-web-components';
-import { ResponseFormat } from './lime-query.types';
+import { ResponseFormat } from '../lime-query.types';
 /**
  * Response Format Editor Component
  *

package/dist/types/components/lime-query-builder/response-format/response-format-helpers.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Helper functions for working with ResponseFormat objects
+ *
+ * These utilities handle parsing, stringifying, and default values
+ * for ResponseFormat in isolation (without full LimeQuery wrapper)
+ */
+import { ResponseFormat } from '../lime-query.types';
+/**
+ * Parse JSON string to ResponseFormat
+ *
+ * @param json - JSON string to parse
+ * @returns Parsed ResponseFormat object
+ * @throws Error if JSON is invalid or not a ResponseFormat
+ */
+export declare function parseResponseFormat(json: string): ResponseFormat;
+/**
+ * Stringify ResponseFormat to JSON
+ *
+ * @param format - ResponseFormat object to stringify
+ * @returns Pretty-printed JSON string
+ */
+export declare function stringifyResponseFormat(format: ResponseFormat): string;
+/**
+ * Get default ResponseFormat (just _id)
+ *
+ * @returns Default ResponseFormat with only _id selected
+ */
+export declare function getDefaultResponseFormat(): ResponseFormat;
+/**
+ * Check if a parsed JSON object is a valid ResponseFormat
+ *
+ * This is a more lenient check than parseResponseFormat - it doesn't throw,
+ * just returns a boolean with optional error message
+ *
+ * @param json - Parsed JSON object to check
+ * @returns Object with `valid` boolean and optional `error` message
+ */
+export declare function isValidResponseFormatStructure(json: any): {
+    valid: boolean;
+    error?: string;
+};
+//# sourceMappingURL=response-format-helpers.d.ts.map

package/dist/types/components/lime-query-builder/{response-format-item.d.ts → response-format/response-format-item.d.ts}

@@ -1,6 +1,6 @@
-import { EventEmitter } from '../../stencil-public-runtime';
+import { EventEmitter } from '../../../stencil-public-runtime';
 import { LimeWebComponent, LimeWebComponentContext, LimeWebComponentPlatform } from '@limetech/lime-web-components';
-import { PropertySelectionItem } from './property-selection-format';
+import { PropertySelectionItem } from '../property-selection-format';
 /**
  * Response Format Property Item Component
  *